modo

type: module

doc: MODO TD API - A more 'pythonic' wrapper around the core MODO Python API intended to make performing common coding tasks easier for TDs. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\__init__.py

modo.ActionClip

type: type

doc: Action Clip and Render pass item. :param item: either an item of type 'actionclip' or an item name/ID to lookup. :type item: an instance of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip._item

type: property

modo.ActionClip._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.active

type: property

doc: Set or get the active state of the render pass. :getter: Returns the active state of the render pass. :rtype: bool :setter: Sets the active state of the renter pass :param state: active state. :type state: bool

modo.ActionClip.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.ActionClip.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.ActionClip.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.ActionClip.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.ActionClip.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.enabled

type: property

doc: Get or set the enabled state of the render pass. :getter: Returns the enabled state. :rtype: bool :setter: Sets the enabled state of the render pass :param state: enabled state. :type state: bool

modo.ActionClip.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.getValue(self,chan,time)

type: instancemethod

doc: Read a value set on a channel for this render pass. :param chan: the channel to read the value from. :type chan: modo.channel.Channel object :param time: the time (in seconds) to read the value for, defaults to 0.0. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.ActionClip.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.ActionClip.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.ActionClip.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.ActionClip.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.ActionClip.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.ActionClip.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.name

type: property

doc: Name of the render pass. :getter: Returns the name of the render pass :rtype: basestring :setter: Assigns a new name to the render pass :param name: new name for the render pass. :type name: basestring

modo.ActionClip.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.ActionClip.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.ActionClip.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.ActionClip.passGroup

type: property

doc: The render pass group that the render pass belongs to. :getter: Returns the render pass group :rtype: modo.item.RenderPassGroup :setter: Sets the render pass group :param group: render pass group to parent to. :type group: modo.item.RenderPassGroup

modo.ActionClip.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.scene

type: property

modo.ActionClip.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.ActionClip.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.setValue(self,chan,value,time,key)

type: instancemethod

doc: Set a value on a channel for this render pass. :param chan: the channel to set the value on. :type chan: modo.channel.Channel object :param value: the value to set for the channel. :type value: any :param time: the time (in seconds) to set the value for, defaults to 0.0. :type time: float :param key: whether to set a key for the value or not, defaults to False. :param key: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ActionClip.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.ActionClip.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Actor

type: type

doc: Wrapper class for actor groups.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor._Actor__addClip(self,name,pose)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor._item

type: property

modo.Actor._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.actions

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.Actor.addAction(self,name)

type: instancemethod

doc: Adds an action to this actor Note: please avoid naming actions 'setup', 'edit' or 'scene' :returns ActionClip: ActionClip :param basestring name: Optional name for the action

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.addPose(self,name,activate)

type: instancemethod

doc: Adds a pose to this actor :returns ActionClip: ActionClip :param basestring name: Optional name for the pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.Actor.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.Actor.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.Actor.currentAction

type: property

doc: :getter: Returns the currently active action if any. None if no action is active :rtype: ActionClip

modo.Actor.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.Actor.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.Actor.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.Actor.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.Actor.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.Actor.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.Actor.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.Actor.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.Actor.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.Actor.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.Actor.items

type: property

doc: :getter: Returns a list of LocatorSuperType items that are connected to this action. :rtype: list

modo.Actor.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.Actor.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.Actor.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.Actor.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.Actor.pose(self,poseName)

type: instancemethod

doc: Return a pose by name :param basestring poseName: Name of the pose to look up :returns: Pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.poses

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.Actor.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.scene

type: property

modo.Actor.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.Actor.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Actor.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Actor.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.AreaLight

type: type

doc: Area light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Area Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. :param light: Optional area light item object (type lx.symbol.sITYPE_AREALIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid area light item selected. :raises TypeError: if the item passed as an argument isn't either an area light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight._item

type: property

modo.AreaLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.AreaLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.AreaLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.AreaLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.AreaLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.AreaLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.AreaLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.AreaLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.AreaLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.AreaLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.AreaLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.AreaLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.AreaLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.AreaLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.AreaLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.AreaLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.AreaLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.AreaLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.AreaLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.AreaLight.scene

type: property

modo.AreaLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.AreaLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.AreaLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.AreaLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.AreaLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.Camera

type: type

doc: Camera item class. Takes an optional 'camera' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'camera' or an item name or ID to look up. If no camera item is supplied as an argument an attempt will be made to wrap the most recently selected camera. :param camera: Optional camera item object (type lx.symbol.sITYPE_CAMERA) or string (item name or ID) to look up. :type camera: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid camera item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'camera' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the camera argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera._item

type: property

modo.Camera._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.Camera.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.Camera.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.Camera.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.Camera.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.Camera.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.Camera.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.Camera.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.Camera.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.Camera.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.Camera.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.Camera.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.Camera.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.Camera.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.Camera.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Camera.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Camera.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Camera.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Camera.scene

type: property

modo.Camera.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.Camera.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Camera.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Camera.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.Camera.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Channel

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Add a link between this channel and another. :param to_channel: The channel to link to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Channel.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Delete a link from the channel graph. :param to_channel: The channel the link is to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Channel.disconnectInput(self,other)

type: instancemethod

doc: Removes an input connection from another channel if it exists. :param Channel other: Other channel to disconnect from. If it is None, all input connections are removed.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Channel.envelope

type: property

doc: Returns the channel's animation envelope. :getter: Returns the channel's animation envelope. :rtype: modo.channel.Envelope :raises LookupError: if the channel isn't animated.

modo.Channel.evalType

type: property

doc: Returns the evaluation type of a channel, which is the type of slot allocated in the eval state vector. This will return the "gradstack" exo-type for gradient channels. :getter: Returns the evaluation type of the channel :rtype: basestring

modo.Channel.forward(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index forward of this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index forward of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Channel.fwdCount

type: property

doc: Returns the number of linked channels forward of this channel in this channel graph. :getter: Returns the number of linked channels forward of this channel in this channel graph. :rtype: int

modo.Channel.fwdLinked

type: property

doc: Returns a list of the linked channels forward of this channel in the channel graph. :getter: Returns the forward channels in this item's channel graph. :rtype: list

modo.Channel.get(self,time,action)

type: instancemethod

doc: Returns a channel's value for an action at a specific time. Defaults to reading the channel's evaluated value at the current time. :param time: Optional time in seconds to read the value at. :type time: float :param action: The action to read the value from. Defaults to None (evaluation). :type action: basestring :returns: the channel's value. :rtype: depends on the type of the channel being read.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Channel.graph

type: property

doc: The channel's channel graph. :getter: Returns the channel's channel graph. :rtype: lxu.object.ChannelGraph

modo.Channel.index

type: property

doc: The channel's index. :getter: Returns the channel's index. :rtype: int

modo.Channel.isAnimated

type: property

doc: Returns whether the channel is animated. :getter: Returns whether the channel is animated or not. :rtype: bool

modo.Channel.item

type: property

doc: :getter: Returns the item that is associated with this channel :rtype: Item

modo.Channel.name

type: property

doc: The channel's name. :getter: Returns the channel's name. :rtype: basestring

modo.Channel.revCount

type: property

doc: Returns the number of linked channels that occur before this channel in the channel graph. :getter: Returns the number of linked channels that occur before this channel in the channel graph. :rtype: int

modo.Channel.reverse(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index before this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index before of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Channel.revLinked

type: property

doc: Returns a list of the linked channels that appear before this channel in the channel graph. :getter: Returns the linked channels that appear before this channel in the channel graph. :rtype: list

modo.Channel.set(self,value,time,key,action)

type: instancemethod

doc: Sets a channel's value for an action at a specific time. Defaults to setting the channel's value for the "edit" action and at the current time. :param value: The value to set for the channel. :type value: depends on the type of the channel :param time: optional time in seconds to set the value for. :type time: float :param key: Specifies whether to set a key for the channel. :type key: bool :param action: The action to set the value on. :type action: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Set a link's position (from index, to index) in the channel graph. :param from_index: The index in the channel graph for the current (from) channel. :type from_index: int :param to_channel: The to channel. :type to_channel: modo.channel.Channel :param to_index: the index in the channel graph for the 'to' channel. :type to_index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Channel.storageType

type: property

doc: Returns the storage type of the channel, which can be valid exo-type name for numeric and stored custom types or None if no storage type is found. :getter: Returns the channel storage type :rtype: basestring

modo.Channel.type

type: property

doc: Returns the channel type. The numeric and gradient types can be keyframed. The return type is an int which translates to the following types: | 0: none | 1: integer | 2: float | 3: gradient | 4: storage | 5: eval :getter: Returns the channel type. :rtype: int

modo.channel

type: module

doc: .. module:: modo.channel :synopsis: A collection of channel related classes & functions. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.channel.Channel

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Add a link between this channel and another. :param to_channel: The channel to link to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Channel.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Delete a link from the channel graph. :param to_channel: The channel the link is to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Channel.disconnectInput(self,other)

type: instancemethod

doc: Removes an input connection from another channel if it exists. :param Channel other: Other channel to disconnect from. If it is None, all input connections are removed.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Channel.envelope

type: property

doc: Returns the channel's animation envelope. :getter: Returns the channel's animation envelope. :rtype: modo.channel.Envelope :raises LookupError: if the channel isn't animated.

modo.channel.Channel.evalType

type: property

doc: Returns the evaluation type of a channel, which is the type of slot allocated in the eval state vector. This will return the "gradstack" exo-type for gradient channels. :getter: Returns the evaluation type of the channel :rtype: basestring

modo.channel.Channel.forward(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index forward of this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index forward of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Channel.fwdCount

type: property

doc: Returns the number of linked channels forward of this channel in this channel graph. :getter: Returns the number of linked channels forward of this channel in this channel graph. :rtype: int

modo.channel.Channel.fwdLinked

type: property

doc: Returns a list of the linked channels forward of this channel in the channel graph. :getter: Returns the forward channels in this item's channel graph. :rtype: list

modo.channel.Channel.get(self,time,action)

type: instancemethod

doc: Returns a channel's value for an action at a specific time. Defaults to reading the channel's evaluated value at the current time. :param time: Optional time in seconds to read the value at. :type time: float :param action: The action to read the value from. Defaults to None (evaluation). :type action: basestring :returns: the channel's value. :rtype: depends on the type of the channel being read.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Channel.graph

type: property

doc: The channel's channel graph. :getter: Returns the channel's channel graph. :rtype: lxu.object.ChannelGraph

modo.channel.Channel.index

type: property

doc: The channel's index. :getter: Returns the channel's index. :rtype: int

modo.channel.Channel.isAnimated

type: property

doc: Returns whether the channel is animated. :getter: Returns whether the channel is animated or not. :rtype: bool

modo.channel.Channel.item

type: property

doc: :getter: Returns the item that is associated with this channel :rtype: Item

modo.channel.Channel.name

type: property

doc: The channel's name. :getter: Returns the channel's name. :rtype: basestring

modo.channel.Channel.revCount

type: property

doc: Returns the number of linked channels that occur before this channel in the channel graph. :getter: Returns the number of linked channels that occur before this channel in the channel graph. :rtype: int

modo.channel.Channel.reverse(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index before this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index before of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Channel.revLinked

type: property

doc: Returns a list of the linked channels that appear before this channel in the channel graph. :getter: Returns the linked channels that appear before this channel in the channel graph. :rtype: list

modo.channel.Channel.set(self,value,time,key,action)

type: instancemethod

doc: Sets a channel's value for an action at a specific time. Defaults to setting the channel's value for the "edit" action and at the current time. :param value: The value to set for the channel. :type value: depends on the type of the channel :param time: optional time in seconds to set the value for. :type time: float :param key: Specifies whether to set a key for the channel. :type key: bool :param action: The action to set the value on. :type action: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Set a link's position (from index, to index) in the channel graph. :param from_index: The index in the channel graph for the current (from) channel. :type from_index: int :param to_channel: The to channel. :type to_channel: modo.channel.Channel :param to_index: the index in the channel graph for the 'to' channel. :type to_index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Channel.storageType

type: property

doc: Returns the storage type of the channel, which can be valid exo-type name for numeric and stored custom types or None if no storage type is found. :getter: Returns the channel storage type :rtype: basestring

modo.channel.Channel.type

type: property

doc: Returns the channel type. The numeric and gradient types can be keyframed. The return type is an int which translates to the following types: | 0: none | 1: integer | 2: float | 3: gradient | 4: storage | 5: eval :getter: Returns the channel type. :rtype: int

modo.channel.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.channel.ChannelRead contents:
  • modo.channel.ChannelRead.__class__
  • modo.channel.ChannelRead.__delattr__
  • modo.channel.ChannelRead.__dict__
  • modo.channel.ChannelRead.__doc__
  • modo.channel.ChannelRead.__format__
  • modo.channel.ChannelRead.__getattr__
  • modo.channel.ChannelRead.__getattribute__
  • modo.channel.ChannelRead.__hash__
  • modo.channel.ChannelRead.__init__
  • modo.channel.ChannelRead.__module__
  • modo.channel.ChannelRead.__new__
  • modo.channel.ChannelRead.__reduce__
  • modo.channel.ChannelRead.__reduce_ex__
  • modo.channel.ChannelRead.__repr__
  • modo.channel.ChannelRead.__setattr__
  • modo.channel.ChannelRead.__sizeof__
  • modo.channel.ChannelRead.__str__
  • modo.channel.ChannelRead.__subclasshook__
  • modo.channel.ChannelRead.__weakref__
  • modo.channel.ChannelRead.set

modo.channel.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.ChannelTriple

type: type

doc: Wrapper to allow setting and reading all three channels on a vector 'channel' at once :param basestring channelName: The channel name. eg 'diffCol' :param modo.item.Item item: The item the channel belongs to. :raises: LookUpError if no respective channel of the given name was found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.channel.ChannelTriple contents:
  • modo.channel.ChannelTriple.__class__
  • modo.channel.ChannelTriple.__delattr__
  • modo.channel.ChannelTriple.__dict__
  • modo.channel.ChannelTriple.__doc__
  • modo.channel.ChannelTriple.__format__
  • modo.channel.ChannelTriple.__getattribute__
  • modo.channel.ChannelTriple.__hash__
  • modo.channel.ChannelTriple.__init__
  • modo.channel.ChannelTriple.__module__
  • modo.channel.ChannelTriple.__new__
  • modo.channel.ChannelTriple.__reduce__
  • modo.channel.ChannelTriple.__reduce_ex__
  • modo.channel.ChannelTriple.__repr__
  • modo.channel.ChannelTriple.__setattr__
  • modo.channel.ChannelTriple.__sizeof__
  • modo.channel.ChannelTriple.__str__
  • modo.channel.ChannelTriple.__subclasshook__
  • modo.channel.ChannelTriple.__weakref__
  • modo.channel.ChannelTriple.get
  • modo.channel.ChannelTriple.set

modo.channel.ChannelTriple.get(self)

type: instancemethod

doc: Same arguments as Channel.get()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.ChannelTriple.set(self,values,time,action)

type: instancemethod

doc: Sets three values for the three channels at once :param float time: Time in seconds for the value to be set at (optional) :param basestring action: Action to set the value for (optional)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.channel.ChannelWrite contents:
  • modo.channel.ChannelWrite.__class__
  • modo.channel.ChannelWrite.__delattr__
  • modo.channel.ChannelWrite.__dict__
  • modo.channel.ChannelWrite.__doc__
  • modo.channel.ChannelWrite.__format__
  • modo.channel.ChannelWrite.__getattr__
  • modo.channel.ChannelWrite.__getattribute__
  • modo.channel.ChannelWrite.__hash__
  • modo.channel.ChannelWrite.__init__
  • modo.channel.ChannelWrite.__module__
  • modo.channel.ChannelWrite.__new__
  • modo.channel.ChannelWrite.__reduce__
  • modo.channel.ChannelWrite.__reduce_ex__
  • modo.channel.ChannelWrite.__repr__
  • modo.channel.ChannelWrite.__setattr__
  • modo.channel.ChannelWrite.__sizeof__
  • modo.channel.ChannelWrite.__str__
  • modo.channel.ChannelWrite.__subclasshook__
  • modo.channel.ChannelWrite.__weakref__
  • modo.channel.ChannelWrite.set

modo.channel.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Envelope

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Envelope.behavior

type: property

doc: gets/sets the behavior of times for both before the first keyframe and after the last keyframe in the envelope. :setter: Sets the envelope behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope behavior :rtype: int

modo.channel.Envelope.clear(self)

type: instancemethod

doc: Clears (removes all keys from) the envelope.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Envelope.interpolation

type: property

doc: Returns the interpolation setting for the envelope. Can be one of: | lx.symbol.iENVv_INTERP_CURVE | lx.symbol.iENVv_INTERP_LINEAR | lx.symbol.iENVv_INTERP_STEPPED :getter: Returns the interpolation setting for the envelope. :rtype: int

modo.channel.Envelope.isInt

type: property

doc: Returns whether the envelope is integer-valued type, if not it's a float type. :Getter: Returns True if the envelope is integer-valued type, False otherwise. :rtype: bool

modo.channel.Envelope.keyframes

type: property

doc: Returns a :class:`Keyframes` object that provides access to the keyframes set for the envelope and methods to manipulate them. :getter: Returns a :class:`Keyframes` object containing the keys for this envelope. :rtype: modo.channel.Keyframes

modo.channel.Envelope.postBehaviour

type: property

doc: gets/sets the behavior of times after the last keyframe in the envelope. :setter: Sets the envelope post behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope post behavior :rtype: int

modo.channel.Envelope.preBehaviour

type: property

doc: gets/sets the behavior of times before the first keyframe in the envelope. - **RESET** A default value, or may be just zero. - **CONSTANT** The value of the first or last keyframe. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **REPEAT** The values in the keyframe range repeating continuously. - **OSCILLATE** Like repeat, but the values run forwards and backward alternately. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **OFFSETREPEAT** Like repeat, but the values are offset in each cycle by the difference between the first and last keyframes. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **LINEAR** Linear interpolation from the slope at the nearest keyframe. - **NONE** Indicates that the envelope does not exist before or after the explicit keyframe range. This can be used by motion evaluation code to decide whether to use the envelope for a channel or to look up the parent envelope or default value. - **CONSTANT_KEEP_SLOPE** As for constant except that the slopes of the first or last keys are not changed. - **OSCILLATE_KEEP_SLOPE** As for oscillate except that the slopes of the first or last keys are not changed. - **OFFSETREPEAT_KEEP_SLOPE** As for offset repeat except that the slopes of the first or last keys are not changed. :setter: Sets the behavior :param behavior: the behaviour to set for the envelope. Can be one of: | lx.symbol.iENV_RESET | lx.symbol.iENV_CONSTANT | lx.symbol.iENV_REPEAT | lx.symbol.iENV_OSCILLATE | lx.symbol.iENV_OFFSETREPEAT | lx.symbol.iENV_LINEAR | lx.symbol.iENV_NONE | lx.symbol.iENV_CONSTANT_KEEP_SLOPE | lx.symbol.iENV_OSCILLATE_KEEP_SLOPE | lx.symbol.iENV_OFFSETREPEAT_KEEP_SLOPE :type behavior: int :getter: Returns envelope behavior :rtype: int

modo.channel.Envelope.value(self,time)

type: instancemethod

doc: Returns the value of the envelope evaluated at the specified time. If no time is explicitly provided the value of the envelope at the current time is returned :param time: time to evaluate envelope at. :type time: float :returns: value of the envelope :rtype: float for float type envelopes, int for integer-valued type envelopes

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Keyframes

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Keyframes._indexFromTime(self,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Keyframes.add(self,val,time)

type: instancemethod

doc: Adds a new keyframe at the specified time. If no time value is passed as an argument a keyframe is set at the current time. :param time: optional time (in seconds) to add a keyframe at. :type time: float :param val: the value to set for the keyframe :type val: int or float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Keyframes.delete(self)

type: instancemethod

doc: Deletes the current key

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Keyframes.first(self)

type: instancemethod

doc: Go to the first keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Keyframes.getSlopeType(self,side)

type: instancemethod

doc: Returns the slope type for either side of a keyframe. :returns: a tuple of the slope type set for the side of the keyframe specified and whether the slope is weighted or not. :rtype: (int, int)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Keyframes.last(self)

type: instancemethod

doc: Go to the last keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Keyframes.next(self)

type: instancemethod

doc: Go to the next keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Keyframes.numKeys

type: property

doc: :getter: Returns the number of keyframes found :rtype: int

modo.channel.Keyframes.prev(self)

type: instancemethod

doc: Go to the previous keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Keyframes.setIndex(self,index)

type: instancemethod

doc: Go to the keyframe by index

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Keyframes.setSlopeType(self,stype,side)

type: instancemethod

doc: Sets the slope type for either side of a keyframe - **SLOPE_DIRECT** the slope of the tangent is set based on the value stored in the key. - **SLOPE_AUTO** the slope of the tangent is calculated automatically with regard to surrounding keys. This is similar to the slope adjustments made by TCB curves. - **SLOPE_LINEAR_IN** the slope of the tangent is calculated to align with the previous key's value. - **SLOPE_LINEAR_OUT** the slope of the tangent is calculated to align with the next key's value. - **SLOPE_FLAT** The slope of the tangent is set to zero. - **SLOPE_AUTOFLAT** the same as auto but if a neighboring key has the same value as the key the slope is set to zero. - **SLOPE_STEPPED** Maintains the value of the previous key between pairs of keys. :param stype: set the slope type for the current keyframe. Can be one of: | lx.symbol.iSLOPE_AUTO | lx.symbol.iSLOPE_AUTOFLAT | lx.symbol.iSLOPE_DIRECT | lx.symbol.iSLOPE_FLAT | lx.symbol.iSLOPE_LINEAR_IN | lx.symbol.iSLOPE_LINEAR_OUT | lx.symbol.iSLOPE_STEPPED :type stype: int :param side: the side of the key (in or out) the slope type is being set for :type side: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.Keyframes.time

type: property

doc: Returns & sets the time for the current keyframe. :setter: Sets the time :param time: the time to move the key to. :type time: float :getter: Returns the time of the current keyframe :rtype: float

modo.channel.Keyframes.value

type: property

doc: Convenience property to get & set value of the current keyframe for the 90% case of an unbroken key. :setter: Sets a value :param val: the value to set for the key. :type val: int or float :getter: Returns the value of an (unbroken) key. :rtype: int or float

modo.channel.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.channel.util.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.channel.util.collections

type: module

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.channel.util.collections._abcoll

type: module

doc: Abstract Base Classes (ABCs) for collections, according to PEP 3119. DON'T USE THIS MODULE DIRECTLY! The classes here should be imported via collections; they are defined here only to alleviate certain bootstrapping issues. Unit tests are in test_collections.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll._hasattr

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.channel.util.collections._abcoll.ABCMeta

type: type

doc: Metaclass for defining Abstract Base Classes (ABCs). Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as 'virtual subclasses' -- these and their descendants will be considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won't show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via super()).

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\abc.pyc

    modo.channel.util.collections._abcoll.ABCMeta contents:
  • modo.channel.util.collections._abcoll.ABCMeta.__base__
  • modo.channel.util.collections._abcoll.ABCMeta.__bases__
  • modo.channel.util.collections._abcoll.ABCMeta.__basicsize__
  • modo.channel.util.collections._abcoll.ABCMeta.__call__
  • modo.channel.util.collections._abcoll.ABCMeta.__class__
  • modo.channel.util.collections._abcoll.ABCMeta.__delattr__
  • modo.channel.util.collections._abcoll.ABCMeta.__dict__
  • modo.channel.util.collections._abcoll.ABCMeta.__dictoffset__
  • modo.channel.util.collections._abcoll.ABCMeta.__doc__
  • modo.channel.util.collections._abcoll.ABCMeta.__eq__
  • modo.channel.util.collections._abcoll.ABCMeta.__flags__
  • modo.channel.util.collections._abcoll.ABCMeta.__format__
  • modo.channel.util.collections._abcoll.ABCMeta.__ge__
  • modo.channel.util.collections._abcoll.ABCMeta.__getattribute__
  • modo.channel.util.collections._abcoll.ABCMeta.__gt__
  • modo.channel.util.collections._abcoll.ABCMeta.__hash__
  • modo.channel.util.collections._abcoll.ABCMeta.__init__
  • modo.channel.util.collections._abcoll.ABCMeta.__instancecheck__
  • modo.channel.util.collections._abcoll.ABCMeta.__itemsize__
  • modo.channel.util.collections._abcoll.ABCMeta.__le__
  • modo.channel.util.collections._abcoll.ABCMeta.__lt__
  • modo.channel.util.collections._abcoll.ABCMeta.__module__
  • modo.channel.util.collections._abcoll.ABCMeta.__mro__
  • modo.channel.util.collections._abcoll.ABCMeta.__name__
  • modo.channel.util.collections._abcoll.ABCMeta.__ne__
  • modo.channel.util.collections._abcoll.ABCMeta.__new__
  • modo.channel.util.collections._abcoll.ABCMeta.__reduce__
  • modo.channel.util.collections._abcoll.ABCMeta.__reduce_ex__
  • modo.channel.util.collections._abcoll.ABCMeta.__repr__
  • modo.channel.util.collections._abcoll.ABCMeta.__setattr__
  • modo.channel.util.collections._abcoll.ABCMeta.__sizeof__
  • modo.channel.util.collections._abcoll.ABCMeta.__str__
  • modo.channel.util.collections._abcoll.ABCMeta.__subclasscheck__
  • modo.channel.util.collections._abcoll.ABCMeta.__subclasses__
  • modo.channel.util.collections._abcoll.ABCMeta.__subclasshook__
  • modo.channel.util.collections._abcoll.ABCMeta.__weakrefoffset__
  • modo.channel.util.collections._abcoll.ABCMeta._abc_invalidation_counter
  • modo.channel.util.collections._abcoll.ABCMeta._dump_registry
  • modo.channel.util.collections._abcoll.ABCMeta.mro
  • modo.channel.util.collections._abcoll.ABCMeta.register

modo.channel.util.collections._abcoll.ABCMeta._abc_invalidation_counter

type: int

modo.channel.util.collections._abcoll.ABCMeta._dump_registry(cls,file)

type: instancemethod

doc: Debug helper to print the ABC registry.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.channel.util.collections._abcoll.ABCMeta.mro()

type: method_descriptor

doc: mro() -> list return a type's method resolution order

modo.channel.util.collections._abcoll.ABCMeta.register(cls,subclass)

type: instancemethod

doc: Register a virtual subclass of an ABC.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.channel.util.collections._abcoll.abstractmethod

type: function

doc: A decorator indicating abstract methods. Requires that the metaclass is ABCMeta or derived from it. A class that has a metaclass derived from ABCMeta cannot be instantiated unless all of its abstract methods are overridden. The abstract methods can be called using any of the normal 'super' call mechanisms. Usage: class C: __metaclass__ = ABCMeta @abstractmethod def my_abstract_method(self, ...): ...

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.channel.util.collections._abcoll.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._abcoll.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.channel.util.collections._abcoll.sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.channel.util.collections._abcoll.sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.channel.util.collections._abcoll.sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.channel.util.collections._abcoll.sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.channel.util.collections._abcoll.sys.api_version

type: int

modo.channel.util.collections._abcoll.sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.channel.util.collections._abcoll.sys.byteorder

type: str

modo.channel.util.collections._abcoll.sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.channel.util.collections._abcoll.sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.channel.util.collections._abcoll.sys.copyright

type: str

modo.channel.util.collections._abcoll.sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.channel.util.collections._abcoll.sys.dllhandle

type: long

modo.channel.util.collections._abcoll.sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.channel.util.collections._abcoll.sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.channel.util.collections._abcoll.sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.channel.util.collections._abcoll.sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.channel.util.collections._abcoll.sys.exc_type

type: type

doc: Inappropriate argument type.

modo.channel.util.collections._abcoll.sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.channel.util.collections._abcoll.sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.channel.util.collections._abcoll.sys.exec_prefix

type: str

modo.channel.util.collections._abcoll.sys.executable

type: str

modo.channel.util.collections._abcoll.sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.channel.util.collections._abcoll.sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.channel.util.collections._abcoll.sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.channel.util.collections._abcoll.sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.channel.util.collections._abcoll.sys.float_repr_style

type: str

modo.channel.util.collections._abcoll.sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.channel.util.collections._abcoll.sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.channel.util.collections._abcoll.sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.channel.util.collections._abcoll.sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.channel.util.collections._abcoll.sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.channel.util.collections._abcoll.sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.channel.util.collections._abcoll.sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.channel.util.collections._abcoll.sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.channel.util.collections._abcoll.sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.channel.util.collections._abcoll.sys.hexversion

type: int

modo.channel.util.collections._abcoll.sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.channel.util.collections._abcoll.sys.maxint

type: int

modo.channel.util.collections._abcoll.sys.maxsize

type: long

modo.channel.util.collections._abcoll.sys.maxunicode

type: int

modo.channel.util.collections._abcoll.sys.meta_path

type: list

modo.channel.util.collections._abcoll.sys.modules

type: dict

modo.channel.util.collections._abcoll.sys.path

type: list

modo.channel.util.collections._abcoll.sys.path_hooks

type: list

modo.channel.util.collections._abcoll.sys.path_importer_cache

type: dict

modo.channel.util.collections._abcoll.sys.platform

type: str

modo.channel.util.collections._abcoll.sys.prefix

type: str

modo.channel.util.collections._abcoll.sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.channel.util.collections._abcoll.sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.channel.util.collections._abcoll.sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.channel.util.collections._abcoll.sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.channel.util.collections._abcoll.sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.channel.util.collections._abcoll.sys.stderr

type: SESysStdErr

modo.channel.util.collections._abcoll.sys.stdin

type: SESysStdIn

modo.channel.util.collections._abcoll.sys.stdout

type: SESysStdOut

modo.channel.util.collections._abcoll.sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.channel.util.collections._abcoll.sys.version

type: str

modo.channel.util.collections._abcoll.sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.channel.util.collections._abcoll.sys.warnoptions

type: list

modo.channel.util.collections._abcoll.sys.winver

type: str

modo.channel.util.collections._abcoll.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections._chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.channel.util.collections._chain contents:
  • modo.channel.util.collections._chain.__class__
  • modo.channel.util.collections._chain.__delattr__
  • modo.channel.util.collections._chain.__doc__
  • modo.channel.util.collections._chain.__format__
  • modo.channel.util.collections._chain.__getattribute__
  • modo.channel.util.collections._chain.__hash__
  • modo.channel.util.collections._chain.__init__
  • modo.channel.util.collections._chain.__iter__
  • modo.channel.util.collections._chain.__new__
  • modo.channel.util.collections._chain.__reduce__
  • modo.channel.util.collections._chain.__reduce_ex__
  • modo.channel.util.collections._chain.__repr__
  • modo.channel.util.collections._chain.__setattr__
  • modo.channel.util.collections._chain.__sizeof__
  • modo.channel.util.collections._chain.__str__
  • modo.channel.util.collections._chain.__subclasshook__
  • modo.channel.util.collections._chain.from_iterable
  • modo.channel.util.collections._chain.next

modo.channel.util.collections._chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.channel.util.collections._chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.channel.util.collections._get_ident()

type: builtin_function_or_method

doc: get_ident() -> integer Return a non-zero integer that uniquely identifies the current thread amongst other threads that exist simultaneously. This may be used to identify per-thread resources. Even though on some platforms threads identities may appear to be allocated consecutive numbers starting at 1, this behavior should not be relied upon, and the number should be seen purely as a magic cookie. A thread's identity may be reused for another thread after it exits.

modo.channel.util.collections._heapq

type: module

doc: Heap queue algorithm (a.k.a. priority queue). Heaps are arrays for which a[k] <= a[2*k+1] and a[k] <= a[2*k+2] for all k, counting elements from 0. For the sake of comparison, non-existing elements are considered to be infinite. The interesting property of a heap is that a[0] is always its smallest element. Usage: heap = [] # creates an empty heap heappush(heap, item) # pushes a new item on the heap item = heappop(heap) # pops the smallest item from the heap item = heap[0] # smallest item on the heap without popping it heapify(x) # transforms list into a heap, in-place, in linear time item = heapreplace(heap, item) # pops and returns smallest item, and adds # new item; the heap size is unchanged Our API differs from textbook heap algorithms as follows: - We use 0-based indexing. This makes the relationship between the index for a node and the indexes for its children slightly less obvious, but is more suitable since Python uses 0-based indexing. - Our heappop() method returns the smallest item, not the largest. These two make it possible to view the heap as a regular Python list without surprises: heap[0] is the smallest item, and heap.sort() maintains the heap invariant!

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\heapq.pyc

modo.channel.util.collections._heapq._nlargest()

type: builtin_function_or_method

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, reverse=True)[:n]

modo.channel.util.collections._heapq._nsmallest()

type: builtin_function_or_method

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable)[:n]

modo.channel.util.collections._heapq._siftdown

type: function

file: .\Lib\heapq.py

modo.channel.util.collections._heapq._siftup

type: function

file: .\Lib\heapq.py

modo.channel.util.collections._heapq.bisect

type: module

doc: Bisection algorithms.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\bisect.pyc

modo.channel.util.collections._heapq.bisect.bisect()

type: builtin_function_or_method

doc: Alias for bisect_right().

modo.channel.util.collections._heapq.bisect.bisect_left()

type: builtin_function_or_method

doc: bisect_left(a, x[, lo[, hi]]) -> index Return the index where to insert item x in list a, assuming a is sorted. The return value i is such that all e in a[:i] have e < x, and all e in a[i:] have e >= x. So if x already appears in the list, i points just before the leftmost x already there. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.channel.util.collections._heapq.bisect.bisect_right()

type: builtin_function_or_method

doc: bisect_right(a, x[, lo[, hi]]) -> index Return the index where to insert item x in list a, assuming a is sorted. The return value i is such that all e in a[:i] have e <= x, and all e in a[i:] have e > x. So if x already appears in the list, i points just beyond the rightmost x already there Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.channel.util.collections._heapq.bisect.insort()

type: builtin_function_or_method

doc: Alias for insort_right().

modo.channel.util.collections._heapq.bisect.insort_left()

type: builtin_function_or_method

doc: insort_left(a, x[, lo[, hi]]) Insert item x in list a, and keep it sorted assuming a is sorted. If x is already in a, insert it to the left of the leftmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.channel.util.collections._heapq.bisect.insort_right()

type: builtin_function_or_method

doc: insort_right(a, x[, lo[, hi]]) Insert item x in list a, and keep it sorted assuming a is sorted. If x is already in a, insert it to the right of the rightmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.channel.util.collections._heapq.chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.channel.util.collections._heapq.chain contents:
  • modo.channel.util.collections._heapq.chain.__class__
  • modo.channel.util.collections._heapq.chain.__delattr__
  • modo.channel.util.collections._heapq.chain.__doc__
  • modo.channel.util.collections._heapq.chain.__format__
  • modo.channel.util.collections._heapq.chain.__getattribute__
  • modo.channel.util.collections._heapq.chain.__hash__
  • modo.channel.util.collections._heapq.chain.__init__
  • modo.channel.util.collections._heapq.chain.__iter__
  • modo.channel.util.collections._heapq.chain.__new__
  • modo.channel.util.collections._heapq.chain.__reduce__
  • modo.channel.util.collections._heapq.chain.__reduce_ex__
  • modo.channel.util.collections._heapq.chain.__repr__
  • modo.channel.util.collections._heapq.chain.__setattr__
  • modo.channel.util.collections._heapq.chain.__sizeof__
  • modo.channel.util.collections._heapq.chain.__str__
  • modo.channel.util.collections._heapq.chain.__subclasshook__
  • modo.channel.util.collections._heapq.chain.from_iterable
  • modo.channel.util.collections._heapq.chain.next

modo.channel.util.collections._heapq.chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.channel.util.collections._heapq.chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.channel.util.collections._heapq.cmp_lt

type: function

file: .\Lib\heapq.py

modo.channel.util.collections._heapq.count

type: type

doc: count(start=0, step=1) --> count object Return a count object whose .next() method returns consecutive values. Equivalent to: def count(firstval=0, step=1): x = firstval while 1: yield x x += step

    modo.channel.util.collections._heapq.count contents:
  • modo.channel.util.collections._heapq.count.__class__
  • modo.channel.util.collections._heapq.count.__delattr__
  • modo.channel.util.collections._heapq.count.__doc__
  • modo.channel.util.collections._heapq.count.__format__
  • modo.channel.util.collections._heapq.count.__getattribute__
  • modo.channel.util.collections._heapq.count.__hash__
  • modo.channel.util.collections._heapq.count.__init__
  • modo.channel.util.collections._heapq.count.__iter__
  • modo.channel.util.collections._heapq.count.__new__
  • modo.channel.util.collections._heapq.count.__reduce__
  • modo.channel.util.collections._heapq.count.__reduce_ex__
  • modo.channel.util.collections._heapq.count.__repr__
  • modo.channel.util.collections._heapq.count.__setattr__
  • modo.channel.util.collections._heapq.count.__sizeof__
  • modo.channel.util.collections._heapq.count.__str__
  • modo.channel.util.collections._heapq.count.__subclasshook__
  • modo.channel.util.collections._heapq.count.next

modo.channel.util.collections._heapq.count.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.channel.util.collections._heapq.heapify()

type: builtin_function_or_method

doc: Transform list into a heap, in-place, in O(len(heap)) time.

modo.channel.util.collections._heapq.heappop()

type: builtin_function_or_method

doc: Pop the smallest item off the heap, maintaining the heap invariant.

modo.channel.util.collections._heapq.heappush()

type: builtin_function_or_method

doc: Push item onto heap, maintaining the heap invariant.

modo.channel.util.collections._heapq.heappushpop()

type: builtin_function_or_method

doc: Push item on the heap, then pop and return the smallest item from the heap. The combined action runs more efficiently than heappush() followed by a separate call to heappop().

modo.channel.util.collections._heapq.heapreplace()

type: builtin_function_or_method

doc: Pop and return the current smallest value, and add the new item. This is more efficient than heappop() followed by heappush(), and can be more appropriate when using a fixed-size heap. Note that the value returned may be larger than item! That constrains reasonable uses of this routine unless written as part of a conditional replacement: if item > heap[0]: item = heapreplace(heap, item)

modo.channel.util.collections._heapq.imap

type: type

doc: imap(func, *iterables) --> imap object Make an iterator that computes the function using arguments from each of the iterables. Like map() except that it returns an iterator instead of a list and that it stops when the shortest iterable is exhausted instead of filling in None for shorter iterables.

    modo.channel.util.collections._heapq.imap contents:
  • modo.channel.util.collections._heapq.imap.__class__
  • modo.channel.util.collections._heapq.imap.__delattr__
  • modo.channel.util.collections._heapq.imap.__doc__
  • modo.channel.util.collections._heapq.imap.__format__
  • modo.channel.util.collections._heapq.imap.__getattribute__
  • modo.channel.util.collections._heapq.imap.__hash__
  • modo.channel.util.collections._heapq.imap.__init__
  • modo.channel.util.collections._heapq.imap.__iter__
  • modo.channel.util.collections._heapq.imap.__new__
  • modo.channel.util.collections._heapq.imap.__reduce__
  • modo.channel.util.collections._heapq.imap.__reduce_ex__
  • modo.channel.util.collections._heapq.imap.__repr__
  • modo.channel.util.collections._heapq.imap.__setattr__
  • modo.channel.util.collections._heapq.imap.__sizeof__
  • modo.channel.util.collections._heapq.imap.__str__
  • modo.channel.util.collections._heapq.imap.__subclasshook__
  • modo.channel.util.collections._heapq.imap.next

modo.channel.util.collections._heapq.imap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.channel.util.collections._heapq.islice

type: type

doc: islice(iterable, [start,] stop [, step]) --> islice object Return an iterator whose next() method returns selected values from an iterable. If start is specified, will skip all preceding elements; otherwise, start defaults to zero. Step defaults to one. If specified as another value, step determines how many values are skipped between successive calls. Works like a slice() on a list but returns an iterator.

    modo.channel.util.collections._heapq.islice contents:
  • modo.channel.util.collections._heapq.islice.__class__
  • modo.channel.util.collections._heapq.islice.__delattr__
  • modo.channel.util.collections._heapq.islice.__doc__
  • modo.channel.util.collections._heapq.islice.__format__
  • modo.channel.util.collections._heapq.islice.__getattribute__
  • modo.channel.util.collections._heapq.islice.__hash__
  • modo.channel.util.collections._heapq.islice.__init__
  • modo.channel.util.collections._heapq.islice.__iter__
  • modo.channel.util.collections._heapq.islice.__new__
  • modo.channel.util.collections._heapq.islice.__reduce__
  • modo.channel.util.collections._heapq.islice.__reduce_ex__
  • modo.channel.util.collections._heapq.islice.__repr__
  • modo.channel.util.collections._heapq.islice.__setattr__
  • modo.channel.util.collections._heapq.islice.__sizeof__
  • modo.channel.util.collections._heapq.islice.__str__
  • modo.channel.util.collections._heapq.islice.__subclasshook__
  • modo.channel.util.collections._heapq.islice.next

modo.channel.util.collections._heapq.islice.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.channel.util.collections._heapq.itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.channel.util.collections._heapq.itemgetter contents:
  • modo.channel.util.collections._heapq.itemgetter.__call__
  • modo.channel.util.collections._heapq.itemgetter.__class__
  • modo.channel.util.collections._heapq.itemgetter.__delattr__
  • modo.channel.util.collections._heapq.itemgetter.__doc__
  • modo.channel.util.collections._heapq.itemgetter.__format__
  • modo.channel.util.collections._heapq.itemgetter.__getattribute__
  • modo.channel.util.collections._heapq.itemgetter.__hash__
  • modo.channel.util.collections._heapq.itemgetter.__init__
  • modo.channel.util.collections._heapq.itemgetter.__new__
  • modo.channel.util.collections._heapq.itemgetter.__reduce__
  • modo.channel.util.collections._heapq.itemgetter.__reduce_ex__
  • modo.channel.util.collections._heapq.itemgetter.__repr__
  • modo.channel.util.collections._heapq.itemgetter.__setattr__
  • modo.channel.util.collections._heapq.itemgetter.__sizeof__
  • modo.channel.util.collections._heapq.itemgetter.__str__
  • modo.channel.util.collections._heapq.itemgetter.__subclasshook__
modo.channel.util.collections._heapq.izip

type: type

doc: izip(iter1 [,iter2 [...]]) --> izip object Return a izip object whose .next() method returns a tuple where the i-th element comes from the i-th iterable argument. The .next() method continues until the shortest iterable in the argument sequence is exhausted and then it raises StopIteration. Works like the zip() function but consumes less memory by returning an iterator instead of a list.

    modo.channel.util.collections._heapq.izip contents:
  • modo.channel.util.collections._heapq.izip.__class__
  • modo.channel.util.collections._heapq.izip.__delattr__
  • modo.channel.util.collections._heapq.izip.__doc__
  • modo.channel.util.collections._heapq.izip.__format__
  • modo.channel.util.collections._heapq.izip.__getattribute__
  • modo.channel.util.collections._heapq.izip.__hash__
  • modo.channel.util.collections._heapq.izip.__init__
  • modo.channel.util.collections._heapq.izip.__iter__
  • modo.channel.util.collections._heapq.izip.__new__
  • modo.channel.util.collections._heapq.izip.__reduce__
  • modo.channel.util.collections._heapq.izip.__reduce_ex__
  • modo.channel.util.collections._heapq.izip.__repr__
  • modo.channel.util.collections._heapq.izip.__setattr__
  • modo.channel.util.collections._heapq.izip.__sizeof__
  • modo.channel.util.collections._heapq.izip.__str__
  • modo.channel.util.collections._heapq.izip.__subclasshook__
  • modo.channel.util.collections._heapq.izip.next

modo.channel.util.collections._heapq.izip.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.channel.util.collections._heapq.merge

type: function

doc: Merge multiple sorted inputs into a single sorted output. Similar to sorted(itertools.chain(*iterables)) but returns a generator, does not pull the data into memory all at once, and assumes that each of the input streams is already sorted (smallest to largest). >>> list(merge([1,3,5,7], [0,2,4,8], [5,10,15,20], [], [25])) [0, 1, 2, 3, 4, 5, 5, 7, 8, 10, 15, 20, 25]

file: .\Lib\heapq.py

modo.channel.util.collections._heapq.nlargest

type: function

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, key=key, reverse=True)[:n]

file: .\Lib\heapq.py

modo.channel.util.collections._heapq.nsmallest

type: function

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable, key=key)[:n]

file: .\Lib\heapq.py

modo.channel.util.collections._heapq.repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.channel.util.collections._heapq.repeat contents:
  • modo.channel.util.collections._heapq.repeat.__class__
  • modo.channel.util.collections._heapq.repeat.__delattr__
  • modo.channel.util.collections._heapq.repeat.__doc__
  • modo.channel.util.collections._heapq.repeat.__format__
  • modo.channel.util.collections._heapq.repeat.__getattribute__
  • modo.channel.util.collections._heapq.repeat.__hash__
  • modo.channel.util.collections._heapq.repeat.__init__
  • modo.channel.util.collections._heapq.repeat.__iter__
  • modo.channel.util.collections._heapq.repeat.__length_hint__
  • modo.channel.util.collections._heapq.repeat.__new__
  • modo.channel.util.collections._heapq.repeat.__reduce__
  • modo.channel.util.collections._heapq.repeat.__reduce_ex__
  • modo.channel.util.collections._heapq.repeat.__repr__
  • modo.channel.util.collections._heapq.repeat.__setattr__
  • modo.channel.util.collections._heapq.repeat.__sizeof__
  • modo.channel.util.collections._heapq.repeat.__str__
  • modo.channel.util.collections._heapq.repeat.__subclasshook__
  • modo.channel.util.collections._heapq.repeat.next

modo.channel.util.collections._heapq.repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.channel.util.collections._heapq.tee()

type: builtin_function_or_method

doc: tee(iterable, n=2) --> tuple of n independent iterators.

modo.channel.util.collections._iskeyword()

type: builtin_function_or_method

doc: x.__contains__(y) <==> y in x.

modo.channel.util.collections._itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.channel.util.collections._itemgetter contents:
  • modo.channel.util.collections._itemgetter.__call__
  • modo.channel.util.collections._itemgetter.__class__
  • modo.channel.util.collections._itemgetter.__delattr__
  • modo.channel.util.collections._itemgetter.__doc__
  • modo.channel.util.collections._itemgetter.__format__
  • modo.channel.util.collections._itemgetter.__getattribute__
  • modo.channel.util.collections._itemgetter.__hash__
  • modo.channel.util.collections._itemgetter.__init__
  • modo.channel.util.collections._itemgetter.__new__
  • modo.channel.util.collections._itemgetter.__reduce__
  • modo.channel.util.collections._itemgetter.__reduce_ex__
  • modo.channel.util.collections._itemgetter.__repr__
  • modo.channel.util.collections._itemgetter.__setattr__
  • modo.channel.util.collections._itemgetter.__sizeof__
  • modo.channel.util.collections._itemgetter.__str__
  • modo.channel.util.collections._itemgetter.__subclasshook__
modo.channel.util.collections._repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.channel.util.collections._repeat contents:
  • modo.channel.util.collections._repeat.__class__
  • modo.channel.util.collections._repeat.__delattr__
  • modo.channel.util.collections._repeat.__doc__
  • modo.channel.util.collections._repeat.__format__
  • modo.channel.util.collections._repeat.__getattribute__
  • modo.channel.util.collections._repeat.__hash__
  • modo.channel.util.collections._repeat.__init__
  • modo.channel.util.collections._repeat.__iter__
  • modo.channel.util.collections._repeat.__length_hint__
  • modo.channel.util.collections._repeat.__new__
  • modo.channel.util.collections._repeat.__reduce__
  • modo.channel.util.collections._repeat.__reduce_ex__
  • modo.channel.util.collections._repeat.__repr__
  • modo.channel.util.collections._repeat.__setattr__
  • modo.channel.util.collections._repeat.__sizeof__
  • modo.channel.util.collections._repeat.__str__
  • modo.channel.util.collections._repeat.__subclasshook__
  • modo.channel.util.collections._repeat.next

modo.channel.util.collections._repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.channel.util.collections._starmap

type: type

doc: starmap(function, sequence) --> starmap object Return an iterator whose values are returned from the function evaluated with a argument tuple taken from the given sequence.

    modo.channel.util.collections._starmap contents:
  • modo.channel.util.collections._starmap.__class__
  • modo.channel.util.collections._starmap.__delattr__
  • modo.channel.util.collections._starmap.__doc__
  • modo.channel.util.collections._starmap.__format__
  • modo.channel.util.collections._starmap.__getattribute__
  • modo.channel.util.collections._starmap.__hash__
  • modo.channel.util.collections._starmap.__init__
  • modo.channel.util.collections._starmap.__iter__
  • modo.channel.util.collections._starmap.__new__
  • modo.channel.util.collections._starmap.__reduce__
  • modo.channel.util.collections._starmap.__reduce_ex__
  • modo.channel.util.collections._starmap.__repr__
  • modo.channel.util.collections._starmap.__setattr__
  • modo.channel.util.collections._starmap.__sizeof__
  • modo.channel.util.collections._starmap.__str__
  • modo.channel.util.collections._starmap.__subclasshook__
  • modo.channel.util.collections._starmap.next

modo.channel.util.collections._starmap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.channel.util.collections._sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.channel.util.collections._sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.channel.util.collections._sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.channel.util.collections._sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.channel.util.collections._sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.channel.util.collections._sys.api_version

type: int

modo.channel.util.collections._sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.channel.util.collections._sys.byteorder

type: str

modo.channel.util.collections._sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.channel.util.collections._sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.channel.util.collections._sys.copyright

type: str

modo.channel.util.collections._sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.channel.util.collections._sys.dllhandle

type: long

modo.channel.util.collections._sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.channel.util.collections._sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.channel.util.collections._sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.channel.util.collections._sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.channel.util.collections._sys.exc_type

type: type

doc: Inappropriate argument type.

    modo.channel.util.collections._sys.exc_type contents:
  • modo.channel.util.collections._sys.exc_type.__class__
  • modo.channel.util.collections._sys.exc_type.__delattr__
  • modo.channel.util.collections._sys.exc_type.__dict__
  • modo.channel.util.collections._sys.exc_type.__doc__
  • modo.channel.util.collections._sys.exc_type.__format__
  • modo.channel.util.collections._sys.exc_type.__getattribute__
  • modo.channel.util.collections._sys.exc_type.__getitem__
  • modo.channel.util.collections._sys.exc_type.__getslice__
  • modo.channel.util.collections._sys.exc_type.__hash__
  • modo.channel.util.collections._sys.exc_type.__init__
  • modo.channel.util.collections._sys.exc_type.__new__
  • modo.channel.util.collections._sys.exc_type.__reduce__
  • modo.channel.util.collections._sys.exc_type.__reduce_ex__
  • modo.channel.util.collections._sys.exc_type.__repr__
  • modo.channel.util.collections._sys.exc_type.__setattr__
  • modo.channel.util.collections._sys.exc_type.__setstate__
  • modo.channel.util.collections._sys.exc_type.__sizeof__
  • modo.channel.util.collections._sys.exc_type.__str__
  • modo.channel.util.collections._sys.exc_type.__subclasshook__
  • modo.channel.util.collections._sys.exc_type.__unicode__
  • modo.channel.util.collections._sys.exc_type.args
  • modo.channel.util.collections._sys.exc_type.message

modo.channel.util.collections._sys.exc_type.args

type: getset_descriptor

modo.channel.util.collections._sys.exc_type.message

type: getset_descriptor

modo.channel.util.collections._sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.channel.util.collections._sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.channel.util.collections._sys.exec_prefix

type: str

modo.channel.util.collections._sys.executable

type: str

modo.channel.util.collections._sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.channel.util.collections._sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.channel.util.collections._sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.channel.util.collections._sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.channel.util.collections._sys.float_repr_style

type: str

modo.channel.util.collections._sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.channel.util.collections._sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.channel.util.collections._sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.channel.util.collections._sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.channel.util.collections._sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.channel.util.collections._sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.channel.util.collections._sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.channel.util.collections._sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.channel.util.collections._sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.channel.util.collections._sys.hexversion

type: int

modo.channel.util.collections._sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.channel.util.collections._sys.maxint

type: int

modo.channel.util.collections._sys.maxsize

type: long

modo.channel.util.collections._sys.maxunicode

type: int

modo.channel.util.collections._sys.meta_path

type: list
modo.channel.util.collections._sys.modules type: dict

modo.channel.util.collections._sys.modules.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.channel.util.collections._sys.modules.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.channel.util.collections._sys.modules.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.channel.util.collections._sys.modules.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.channel.util.collections._sys.modules.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.channel.util.collections._sys.modules.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.channel.util.collections._sys.modules.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.channel.util.collections._sys.modules.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.channel.util.collections._sys.modules.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.channel.util.collections._sys.modules.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.channel.util.collections._sys.modules.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.channel.util.collections._sys.modules.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.channel.util.collections._sys.modules.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.channel.util.collections._sys.modules.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.channel.util.collections._sys.modules.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.channel.util.collections._sys.modules.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.channel.util.collections._sys.modules.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.channel.util.collections._sys.modules.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.channel.util.collections._sys.path

type: list

modo.channel.util.collections._sys.path_hooks

type: list
modo.channel.util.collections._sys.path_importer_cache type: dict

modo.channel.util.collections._sys.path_importer_cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.channel.util.collections._sys.path_importer_cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.channel.util.collections._sys.path_importer_cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.channel.util.collections._sys.path_importer_cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.channel.util.collections._sys.path_importer_cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.channel.util.collections._sys.path_importer_cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.channel.util.collections._sys.path_importer_cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.channel.util.collections._sys.path_importer_cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.channel.util.collections._sys.path_importer_cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.channel.util.collections._sys.path_importer_cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.channel.util.collections._sys.path_importer_cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.channel.util.collections._sys.path_importer_cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.channel.util.collections._sys.path_importer_cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.channel.util.collections._sys.path_importer_cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.channel.util.collections._sys.path_importer_cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.channel.util.collections._sys.path_importer_cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.channel.util.collections._sys.path_importer_cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.channel.util.collections._sys.path_importer_cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.channel.util.collections._sys.platform

type: str

modo.channel.util.collections._sys.prefix

type: str

modo.channel.util.collections._sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.channel.util.collections._sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.channel.util.collections._sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.channel.util.collections._sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.channel.util.collections._sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.channel.util.collections._sys.stderr

type: SESysStdErr

modo.channel.util.collections._sys.stdin

type: SESysStdIn

modo.channel.util.collections._sys.stdout

type: SESysStdOut

modo.channel.util.collections._sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.channel.util.collections._sys.version

type: str

modo.channel.util.collections._sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.channel.util.collections._sys.warnoptions

type: list

modo.channel.util.collections._sys.winver

type: str

modo.channel.util.collections.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.Counter

type: type

doc: Dict subclass for counting hashable items. Sometimes called a bag or multiset. Elements are stored as dictionary keys and their counts are stored as dictionary values. >>> c = Counter('abcdeabcdabcaba') # count elements from a string >>> c.most_common(3) # three most common elements [('a', 5), ('b', 4), ('c', 3)] >>> sorted(c) # list all unique elements ['a', 'b', 'c', 'd', 'e'] >>> ''.join(sorted(c.elements())) # list elements with repetitions 'aaaaabbbbcccdde' >>> sum(c.values()) # total of all counts 15 >>> c['a'] # count of letter 'a' 5 >>> for elem in 'shazam': # update counts from an iterable ... c[elem] += 1 # by adding 1 to each element's count >>> c['a'] # now there are seven 'a' 7 >>> del c['b'] # remove all 'b' >>> c['b'] # now there are zero 'b' 0 >>> d = Counter('simsalabim') # make another counter >>> c.update(d) # add in the second counter >>> c['a'] # now there are nine 'a' 9 >>> c.clear() # empty the counter >>> c Counter() Note: If a count is set to zero or reduced to zero, it will remain in the counter until the entry is deleted or the counter is cleared: >>> c = Counter('aaabbc') >>> c['b'] -= 2 # reduce the count of 'b' by two >>> c.most_common() # 'b' is still in, but its count is zero [('a', 3), ('c', 1), ('b', 0)]

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.channel.util.collections.Counter.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.channel.util.collections.Counter.copy(self)

type: instancemethod

doc: Return a shallow copy.

file: .\Lib\collections.py

modo.channel.util.collections.Counter.elements(self)

type: instancemethod

doc: Iterator over elements repeating each as many times as its count. >>> c = Counter('ABCABC') >>> sorted(c.elements()) ['A', 'A', 'B', 'B', 'C', 'C'] # Knuth's example for prime factors of 1836: 2**2 * 3**3 * 17**1 >>> prime_factors = Counter({2: 2, 3: 3, 17: 1}) >>> product = 1 >>> for factor in prime_factors.elements(): # loop over factors ... product *= factor # and multiply them >>> product 1836 Note, if an element's count has been set to zero or is a negative number, elements() will ignore it.

file: .\Lib\collections.py

modo.channel.util.collections.Counter.fromkeys(cls,iterable,v)

type: instancemethod

file: .\Lib\collections.py

modo.channel.util.collections.Counter.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.channel.util.collections.Counter.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.channel.util.collections.Counter.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.channel.util.collections.Counter.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.channel.util.collections.Counter.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.channel.util.collections.Counter.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.channel.util.collections.Counter.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.channel.util.collections.Counter.most_common(self,n)

type: instancemethod

doc: List the n most common elements and their counts from the most common to the least. If n is None, then list all element counts. >>> Counter('abcdeabcdabcaba').most_common(3) [('a', 5), ('b', 4), ('c', 3)]

file: .\Lib\collections.py

modo.channel.util.collections.Counter.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.channel.util.collections.Counter.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.channel.util.collections.Counter.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.channel.util.collections.Counter.subtract(self,iterable)

type: instancemethod

doc: Like dict.update() but subtracts counts instead of replacing them. Counts can be reduced below zero. Both the inputs and outputs are allowed to contain zero and negative counts. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.subtract('witch') # subtract elements from another iterable >>> c.subtract(Counter('watch')) # subtract elements from another counter >>> c['h'] # 2 in which, minus 1 in witch, minus 1 in watch 0 >>> c['w'] # 1 in which, minus 1 in witch, minus 1 in watch -1

file: .\Lib\collections.py

modo.channel.util.collections.Counter.update(self,iterable)

type: instancemethod

doc: Like dict.update() but add counts instead of replacing them. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.update('witch') # add elements from another iterable >>> d = Counter('watch') >>> c.update(d) # add elements from another counter >>> c['h'] # four 'h' in which, witch, and watch 4

file: .\Lib\collections.py

modo.channel.util.collections.Counter.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.channel.util.collections.Counter.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.channel.util.collections.Counter.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.channel.util.collections.Counter.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.channel.util.collections.defaultdict

type: type

doc: defaultdict(default_factory) --> dict with default factory The default factory is called without arguments to produce a new value when a key is not present, in __getitem__ only. A defaultdict compares equal to a dict with the same items.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.channel.util.collections.defaultdict.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.channel.util.collections.defaultdict.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D.

modo.channel.util.collections.defaultdict.default_factory

type: member_descriptor

doc: Factory for default value called by __missing__().

modo.channel.util.collections.defaultdict.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.channel.util.collections.defaultdict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.channel.util.collections.defaultdict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.channel.util.collections.defaultdict.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.channel.util.collections.defaultdict.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.channel.util.collections.defaultdict.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.channel.util.collections.defaultdict.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.channel.util.collections.defaultdict.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.channel.util.collections.defaultdict.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.channel.util.collections.defaultdict.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.channel.util.collections.defaultdict.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.channel.util.collections.defaultdict.update()

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.channel.util.collections.defaultdict.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.channel.util.collections.defaultdict.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.channel.util.collections.defaultdict.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.channel.util.collections.defaultdict.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.channel.util.collections.deque

type: type

doc: deque(iterable[, maxlen]) --> deque object Build an ordered collection with optimized access from its endpoints.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.channel.util.collections.deque.append()

type: method_descriptor

doc: Add an element to the right side of the deque.

modo.channel.util.collections.deque.appendleft()

type: method_descriptor

doc: Add an element to the left side of the deque.

modo.channel.util.collections.deque.clear()

type: method_descriptor

doc: Remove all elements from the deque.

modo.channel.util.collections.deque.count()

type: method_descriptor

doc: D.count(value) -> integer -- return number of occurrences of value

modo.channel.util.collections.deque.extend()

type: method_descriptor

doc: Extend the right side of the deque with elements from the iterable

modo.channel.util.collections.deque.extendleft()

type: method_descriptor

doc: Extend the left side of the deque with elements from the iterable

modo.channel.util.collections.deque.maxlen

type: getset_descriptor

doc: maximum size of a deque or None if unbounded

modo.channel.util.collections.deque.pop()

type: method_descriptor

doc: Remove and return the rightmost element.

modo.channel.util.collections.deque.popleft()

type: method_descriptor

doc: Remove and return the leftmost element.

modo.channel.util.collections.deque.remove()

type: method_descriptor

doc: D.remove(value) -- remove first occurrence of value.

modo.channel.util.collections.deque.reverse()

type: method_descriptor

doc: D.reverse() -- reverse *IN PLACE*

modo.channel.util.collections.deque.rotate()

type: method_descriptor

doc: Rotate the deque n steps to the right (default n=1). If n is negative, rotates left.

modo.channel.util.collections.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.namedtuple

type: function

doc: Returns a new subclass of tuple with named fields. >>> Point = namedtuple('Point', 'x y') >>> Point.__doc__ # docstring for the new class 'Point(x, y)' >>> p = Point(11, y=22) # instantiate with positional args or keywords >>> p[0] + p[1] # indexable like a plain tuple 33 >>> x, y = p # unpack like a regular tuple >>> x, y (11, 22) >>> p.x + p.y # fields also accessable by name 33 >>> d = p._asdict() # convert to a dictionary >>> d['x'] 11 >>> Point(**d) # convert from a dictionary Point(x=11, y=22) >>> p._replace(x=100) # _replace() is like str.replace() but targets named fields Point(x=100, y=22)

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict

type: type

doc: Dictionary that remembers insertion order

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.channel.util.collections.OrderedDict._OrderedDict__marker

type: object

doc: The most base type

modo.channel.util.collections.OrderedDict._OrderedDict__update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.channel.util.collections.OrderedDict.clear(self)

type: instancemethod

doc: od.clear() -> None. Remove all items from od.

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.copy(self)

type: instancemethod

doc: od.copy() -> a shallow copy of od

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.fromkeys(cls,iterable,value)

type: instancemethod

doc: OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S. If not specified, the value defaults to None.

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.channel.util.collections.OrderedDict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.channel.util.collections.OrderedDict.items(self)

type: instancemethod

doc: od.items() -> list of (key, value) pairs in od

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.iteritems(self)

type: instancemethod

doc: od.iteritems -> an iterator over the (key, value) pairs in od

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.iterkeys(self)

type: instancemethod

doc: od.iterkeys() -> an iterator over the keys in od

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.itervalues(self)

type: instancemethod

doc: od.itervalues -> an iterator over the values in od

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.keys(self)

type: instancemethod

doc: od.keys() -> list of keys in od

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.pop(self,key,default)

type: instancemethod

doc: od.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.popitem(self,last)

type: instancemethod

doc: od.popitem() -> (k, v), return and remove a (key, value) pair. Pairs are returned in LIFO order if last is true or FIFO order if false.

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.setdefault(self,key,default)

type: instancemethod

doc: od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.channel.util.collections.OrderedDict.values(self)

type: instancemethod

doc: od.values() -> list of values in od

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.viewitems(self)

type: instancemethod

doc: od.viewitems() -> a set-like object providing a view on od's items

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.viewkeys(self)

type: instancemethod

doc: od.viewkeys() -> a set-like object providing a view on od's keys

file: .\Lib\collections.py

modo.channel.util.collections.OrderedDict.viewvalues(self)

type: instancemethod

doc: od.viewvalues() -> an object providing a view on od's values

file: .\Lib\collections.py

modo.channel.util.collections.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.collections.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.ensureModoItem

type: function

doc: Decorator - ensures that the argument passed as the first parameter to a function is an instance of the modo :class:`Item` class. Should only only be used to decorate methods where the first argument is meant to be an item and ensures that if for any reason an item of either type lx.object.Item or lxu.object.Item gets passed to the method it will get wrapped as an modo.item.Item object before being used.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.channel.util.floatEquals

type: function

doc: Test if two floats are equal :returns bool:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.channel.util.functools

type: module

doc: functools.py - Tools for working with functions and callable objects

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

modo.channel.util.functools.cmp_to_key

type: function

doc: Convert a cmp= function into a key= function

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.channel.util.functools.partial

type: type

doc: partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

    modo.channel.util.functools.partial contents:
  • modo.channel.util.functools.partial.__call__
  • modo.channel.util.functools.partial.__class__
  • modo.channel.util.functools.partial.__delattr__
  • modo.channel.util.functools.partial.__dict__
  • modo.channel.util.functools.partial.__doc__
  • modo.channel.util.functools.partial.__format__
  • modo.channel.util.functools.partial.__getattribute__
  • modo.channel.util.functools.partial.__hash__
  • modo.channel.util.functools.partial.__init__
  • modo.channel.util.functools.partial.__new__
  • modo.channel.util.functools.partial.__reduce__
  • modo.channel.util.functools.partial.__reduce_ex__
  • modo.channel.util.functools.partial.__repr__
  • modo.channel.util.functools.partial.__setattr__
  • modo.channel.util.functools.partial.__setstate__
  • modo.channel.util.functools.partial.__sizeof__
  • modo.channel.util.functools.partial.__str__
  • modo.channel.util.functools.partial.__subclasshook__
  • modo.channel.util.functools.partial.args
  • modo.channel.util.functools.partial.func
  • modo.channel.util.functools.partial.keywords

modo.channel.util.functools.partial.args

type: member_descriptor

doc: tuple of arguments to future partial calls

modo.channel.util.functools.partial.func

type: member_descriptor

doc: function object to use in future partial calls

modo.channel.util.functools.partial.keywords

type: member_descriptor

doc: dictionary of keyword arguments to future partial calls

modo.channel.util.functools.reduce()

type: builtin_function_or_method

doc: reduce(function, sequence[, initial]) -> value Apply a function of two arguments cumulatively to the items of a sequence, from left to right, so as to reduce the sequence to a single value. For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates ((((1+2)+3)+4)+5). If initial is present, it is placed before the items of the sequence in the calculation, and serves as a default when the sequence is empty.

modo.channel.util.functools.total_ordering

type: function

doc: Class decorator that fills in missing ordering methods

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.channel.util.functools.update_wrapper

type: function

doc: Update a wrapper function to look like the wrapped function wrapper is the function to be updated wrapped is the original function assigned is a tuple naming the attributes assigned directly from the wrapped function to the wrapper function (defaults to functools.WRAPPER_ASSIGNMENTS) updated is a tuple naming the attributes of the wrapper that are updated with the corresponding attribute from the wrapped function (defaults to functools.WRAPPER_UPDATES)

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.channel.util.functools.WRAPPER_ASSIGNMENTS

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.channel.util.functools.WRAPPER_UPDATES

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.channel.util.functools.wraps

type: function

doc: Decorator factory to apply update_wrapper() to a wrapper function Returns a decorator that invokes update_wrapper() with the decorated function as the wrapper argument and the arguments to wraps() as the remaining arguments. Default arguments are as for update_wrapper(). This is a convenience function to simplify applying partial() to update_wrapper().

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.channel.util.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip

type: type

doc: Action Clip and Render pass item. :param item: either an item of type 'actionclip' or an item name/ID to lookup. :type item: an instance of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip._item

type: property

modo.channel.util.item.ActionClip._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.active

type: property

doc: Set or get the active state of the render pass. :getter: Returns the active state of the render pass. :rtype: bool :setter: Sets the active state of the renter pass :param state: active state. :type state: bool

modo.channel.util.item.ActionClip.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.ActionClip.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.ActionClip.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.ActionClip.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.ActionClip.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.enabled

type: property

doc: Get or set the enabled state of the render pass. :getter: Returns the enabled state. :rtype: bool :setter: Sets the enabled state of the render pass :param state: enabled state. :type state: bool

modo.channel.util.item.ActionClip.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.getValue(self,chan,time)

type: instancemethod

doc: Read a value set on a channel for this render pass. :param chan: the channel to read the value from. :type chan: modo.channel.Channel object :param time: the time (in seconds) to read the value for, defaults to 0.0. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.ActionClip.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.ActionClip.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.ActionClip.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.ActionClip.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.ActionClip.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.ActionClip.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.name

type: property

doc: Name of the render pass. :getter: Returns the name of the render pass :rtype: basestring :setter: Assigns a new name to the render pass :param name: new name for the render pass. :type name: basestring

modo.channel.util.item.ActionClip.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.ActionClip.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.ActionClip.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.ActionClip.passGroup

type: property

doc: The render pass group that the render pass belongs to. :getter: Returns the render pass group :rtype: modo.item.RenderPassGroup :setter: Sets the render pass group :param group: render pass group to parent to. :type group: modo.item.RenderPassGroup

modo.channel.util.item.ActionClip.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.scene

type: property

modo.channel.util.item.ActionClip.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.ActionClip.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.setValue(self,chan,value,time,key)

type: instancemethod

doc: Set a value on a channel for this render pass. :param chan: the channel to set the value on. :type chan: modo.channel.Channel object :param value: the value to set for the channel. :type value: any :param time: the time (in seconds) to set the value for, defaults to 0.0. :type time: float :param key: whether to set a key for the value or not, defaults to False. :param key: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ActionClip.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.ActionClip.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Actor

type: type

doc: Wrapper class for actor groups.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor._Actor__addClip(self,name,pose)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor._item

type: property

modo.channel.util.item.Actor._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.actions

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.channel.util.item.Actor.addAction(self,name)

type: instancemethod

doc: Adds an action to this actor Note: please avoid naming actions 'setup', 'edit' or 'scene' :returns ActionClip: ActionClip :param basestring name: Optional name for the action

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.addPose(self,name,activate)

type: instancemethod

doc: Adds a pose to this actor :returns ActionClip: ActionClip :param basestring name: Optional name for the pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.Actor.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.Actor.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.Actor.currentAction

type: property

doc: :getter: Returns the currently active action if any. None if no action is active :rtype: ActionClip

modo.channel.util.item.Actor.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.Actor.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.channel.util.item.Actor.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.channel.util.item.Actor.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.Actor.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.Actor.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.Actor.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.Actor.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.channel.util.item.Actor.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.Actor.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.Actor.items

type: property

doc: :getter: Returns a list of LocatorSuperType items that are connected to this action. :rtype: list

modo.channel.util.item.Actor.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.Actor.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.Actor.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.Actor.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.Actor.pose(self,poseName)

type: instancemethod

doc: Return a pose by name :param basestring poseName: Name of the pose to look up :returns: Pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.poses

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.channel.util.item.Actor.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.scene

type: property

modo.channel.util.item.Actor.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.Actor.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Actor.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Actor.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.channel.util.item.AreaLight

type: type

doc: Area light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Area Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. :param light: Optional area light item object (type lx.symbol.sITYPE_AREALIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid area light item selected. :raises TypeError: if the item passed as an argument isn't either an area light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight._item

type: property

modo.channel.util.item.AreaLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.AreaLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.AreaLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.AreaLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.AreaLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.AreaLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.AreaLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.AreaLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.AreaLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.AreaLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.AreaLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.channel.util.item.AreaLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.AreaLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.AreaLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.AreaLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.AreaLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.AreaLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.AreaLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.AreaLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.AreaLight.scene

type: property

modo.channel.util.item.AreaLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.AreaLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.AreaLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.AreaLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.AreaLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.channel.util.item.Camera

type: type

doc: Camera item class. Takes an optional 'camera' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'camera' or an item name or ID to look up. If no camera item is supplied as an argument an attempt will be made to wrap the most recently selected camera. :param camera: Optional camera item object (type lx.symbol.sITYPE_CAMERA) or string (item name or ID) to look up. :type camera: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid camera item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'camera' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the camera argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera._item

type: property

modo.channel.util.item.Camera._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.Camera.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.Camera.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.Camera.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.Camera.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.Camera.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.Camera.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.Camera.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.Camera.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.Camera.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.Camera.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.Camera.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.Camera.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.Camera.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.Camera.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Camera.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Camera.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Camera.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Camera.scene

type: property

modo.channel.util.item.Camera.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.Camera.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Camera.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Camera.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.Camera.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Channel

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Add a link between this channel and another. :param to_channel: The channel to link to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Channel.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Delete a link from the channel graph. :param to_channel: The channel the link is to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Channel.disconnectInput(self,other)

type: instancemethod

doc: Removes an input connection from another channel if it exists. :param Channel other: Other channel to disconnect from. If it is None, all input connections are removed.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Channel.envelope

type: property

doc: Returns the channel's animation envelope. :getter: Returns the channel's animation envelope. :rtype: modo.channel.Envelope :raises LookupError: if the channel isn't animated.

modo.channel.util.item.Channel.evalType

type: property

doc: Returns the evaluation type of a channel, which is the type of slot allocated in the eval state vector. This will return the "gradstack" exo-type for gradient channels. :getter: Returns the evaluation type of the channel :rtype: basestring

modo.channel.util.item.Channel.forward(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index forward of this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index forward of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Channel.fwdCount

type: property

doc: Returns the number of linked channels forward of this channel in this channel graph. :getter: Returns the number of linked channels forward of this channel in this channel graph. :rtype: int

modo.channel.util.item.Channel.fwdLinked

type: property

doc: Returns a list of the linked channels forward of this channel in the channel graph. :getter: Returns the forward channels in this item's channel graph. :rtype: list

modo.channel.util.item.Channel.get(self,time,action)

type: instancemethod

doc: Returns a channel's value for an action at a specific time. Defaults to reading the channel's evaluated value at the current time. :param time: Optional time in seconds to read the value at. :type time: float :param action: The action to read the value from. Defaults to None (evaluation). :type action: basestring :returns: the channel's value. :rtype: depends on the type of the channel being read.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Channel.graph

type: property

doc: The channel's channel graph. :getter: Returns the channel's channel graph. :rtype: lxu.object.ChannelGraph

modo.channel.util.item.Channel.index

type: property

doc: The channel's index. :getter: Returns the channel's index. :rtype: int

modo.channel.util.item.Channel.isAnimated

type: property

doc: Returns whether the channel is animated. :getter: Returns whether the channel is animated or not. :rtype: bool

modo.channel.util.item.Channel.item

type: property

doc: :getter: Returns the item that is associated with this channel :rtype: Item

modo.channel.util.item.Channel.name

type: property

doc: The channel's name. :getter: Returns the channel's name. :rtype: basestring

modo.channel.util.item.Channel.revCount

type: property

doc: Returns the number of linked channels that occur before this channel in the channel graph. :getter: Returns the number of linked channels that occur before this channel in the channel graph. :rtype: int

modo.channel.util.item.Channel.reverse(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index before this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index before of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Channel.revLinked

type: property

doc: Returns a list of the linked channels that appear before this channel in the channel graph. :getter: Returns the linked channels that appear before this channel in the channel graph. :rtype: list

modo.channel.util.item.Channel.set(self,value,time,key,action)

type: instancemethod

doc: Sets a channel's value for an action at a specific time. Defaults to setting the channel's value for the "edit" action and at the current time. :param value: The value to set for the channel. :type value: depends on the type of the channel :param time: optional time in seconds to set the value for. :type time: float :param key: Specifies whether to set a key for the channel. :type key: bool :param action: The action to set the value on. :type action: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Set a link's position (from index, to index) in the channel graph. :param from_index: The index in the channel graph for the current (from) channel. :type from_index: int :param to_channel: The to channel. :type to_channel: modo.channel.Channel :param to_index: the index in the channel graph for the 'to' channel. :type to_index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Channel.storageType

type: property

doc: Returns the storage type of the channel, which can be valid exo-type name for numeric and stored custom types or None if no storage type is found. :getter: Returns the channel storage type :rtype: basestring

modo.channel.util.item.Channel.type

type: property

doc: Returns the channel type. The numeric and gradient types can be keyframed. The return type is an int which translates to the following types: | 0: none | 1: integer | 2: float | 3: gradient | 4: storage | 5: eval :getter: Returns the channel type. :rtype: int

modo.channel.util.item.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.channel.util.item.ChannelRead contents:
  • modo.channel.util.item.ChannelRead.__class__
  • modo.channel.util.item.ChannelRead.__delattr__
  • modo.channel.util.item.ChannelRead.__dict__
  • modo.channel.util.item.ChannelRead.__doc__
  • modo.channel.util.item.ChannelRead.__format__
  • modo.channel.util.item.ChannelRead.__getattr__
  • modo.channel.util.item.ChannelRead.__getattribute__
  • modo.channel.util.item.ChannelRead.__hash__
  • modo.channel.util.item.ChannelRead.__init__
  • modo.channel.util.item.ChannelRead.__module__
  • modo.channel.util.item.ChannelRead.__new__
  • modo.channel.util.item.ChannelRead.__reduce__
  • modo.channel.util.item.ChannelRead.__reduce_ex__
  • modo.channel.util.item.ChannelRead.__repr__
  • modo.channel.util.item.ChannelRead.__setattr__
  • modo.channel.util.item.ChannelRead.__sizeof__
  • modo.channel.util.item.ChannelRead.__str__
  • modo.channel.util.item.ChannelRead.__subclasshook__
  • modo.channel.util.item.ChannelRead.__weakref__
  • modo.channel.util.item.ChannelRead.set

modo.channel.util.item.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.ChannelTriple

type: type

doc: Wrapper to allow setting and reading all three channels on a vector 'channel' at once :param basestring channelName: The channel name. eg 'diffCol' :param modo.item.Item item: The item the channel belongs to. :raises: LookUpError if no respective channel of the given name was found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.channel.util.item.ChannelTriple contents:
  • modo.channel.util.item.ChannelTriple.__class__
  • modo.channel.util.item.ChannelTriple.__delattr__
  • modo.channel.util.item.ChannelTriple.__dict__
  • modo.channel.util.item.ChannelTriple.__doc__
  • modo.channel.util.item.ChannelTriple.__format__
  • modo.channel.util.item.ChannelTriple.__getattribute__
  • modo.channel.util.item.ChannelTriple.__hash__
  • modo.channel.util.item.ChannelTriple.__init__
  • modo.channel.util.item.ChannelTriple.__module__
  • modo.channel.util.item.ChannelTriple.__new__
  • modo.channel.util.item.ChannelTriple.__reduce__
  • modo.channel.util.item.ChannelTriple.__reduce_ex__
  • modo.channel.util.item.ChannelTriple.__repr__
  • modo.channel.util.item.ChannelTriple.__setattr__
  • modo.channel.util.item.ChannelTriple.__sizeof__
  • modo.channel.util.item.ChannelTriple.__str__
  • modo.channel.util.item.ChannelTriple.__subclasshook__
  • modo.channel.util.item.ChannelTriple.__weakref__
  • modo.channel.util.item.ChannelTriple.get
  • modo.channel.util.item.ChannelTriple.set

modo.channel.util.item.ChannelTriple.get(self)

type: instancemethod

doc: Same arguments as Channel.get()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.ChannelTriple.set(self,values,time,action)

type: instancemethod

doc: Sets three values for the three channels at once :param float time: Time in seconds for the value to be set at (optional) :param basestring action: Action to set the value for (optional)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.channel.util.item.ChannelWrite contents:
  • modo.channel.util.item.ChannelWrite.__class__
  • modo.channel.util.item.ChannelWrite.__delattr__
  • modo.channel.util.item.ChannelWrite.__dict__
  • modo.channel.util.item.ChannelWrite.__doc__
  • modo.channel.util.item.ChannelWrite.__format__
  • modo.channel.util.item.ChannelWrite.__getattr__
  • modo.channel.util.item.ChannelWrite.__getattribute__
  • modo.channel.util.item.ChannelWrite.__hash__
  • modo.channel.util.item.ChannelWrite.__init__
  • modo.channel.util.item.ChannelWrite.__module__
  • modo.channel.util.item.ChannelWrite.__new__
  • modo.channel.util.item.ChannelWrite.__reduce__
  • modo.channel.util.item.ChannelWrite.__reduce_ex__
  • modo.channel.util.item.ChannelWrite.__repr__
  • modo.channel.util.item.ChannelWrite.__setattr__
  • modo.channel.util.item.ChannelWrite.__sizeof__
  • modo.channel.util.item.ChannelWrite.__str__
  • modo.channel.util.item.ChannelWrite.__subclasshook__
  • modo.channel.util.item.ChannelWrite.__weakref__
  • modo.channel.util.item.ChannelWrite.set

modo.channel.util.item.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.CylinderLight

type: type

doc: Cylinder light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Cylinder Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Cylinder Light item. :param light: Optional Cylinder light item object (type lx.symbol.sITYPE_CYLINDERLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid cylinder light item selected. :raises TypeError: if the item passed as an argument isn't either a cylinder light or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight._item

type: property

modo.channel.util.item.CylinderLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.CylinderLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.CylinderLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.CylinderLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.CylinderLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.CylinderLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.CylinderLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.CylinderLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.CylinderLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.CylinderLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.CylinderLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.channel.util.item.CylinderLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.CylinderLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.CylinderLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.CylinderLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.CylinderLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.CylinderLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.CylinderLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.CylinderLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.CylinderLight.scene

type: property

modo.channel.util.item.CylinderLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.CylinderLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.CylinderLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.CylinderLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.CylinderLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Deformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer._item

type: property

modo.channel.util.item.Deformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.Deformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.Deformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.Deformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.Deformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.Deformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.Deformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.Deformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.Deformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.Deformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.Deformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.channel.util.item.Deformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.Deformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.channel.util.item.Deformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.Deformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.Deformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.Deformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.scene

type: property

modo.channel.util.item.Deformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.Deformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Deformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Deformer.svc

type: Deformer

modo.channel.util.item.Deformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.DeformerGroup

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup._item

type: property

modo.channel.util.item.DeformerGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.DeformerGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.DeformerGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.DeformerGroup.connectInput(self,other)

type: instancemethod

doc: Connects an influence deformer into this deformGroup :param other:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.createJointLocator(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.DeformerGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.DeformerGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.DeformerGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.DeformerGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.DeformerGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.DeformerGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.DeformerGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.mesh(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.DeformerGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.DeformerGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.DeformerGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.DeformerGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.scene

type: property

modo.channel.util.item.DeformerGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.DeformerGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DeformerGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.DeformerGroup.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.DirectionalLight

type: type

doc: Directional light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Directional Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Directional Light item. :param light: Optional Directional light item object (type lx.symbol.sITYPE_SUNLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid directional light item selected. :raises TypeError: if the item passed as an argument isn't either a Directional light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight._item

type: property

modo.channel.util.item.DirectionalLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.DirectionalLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.DirectionalLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.DirectionalLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.DirectionalLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.DirectionalLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.DirectionalLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.DirectionalLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.DirectionalLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.DirectionalLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.DirectionalLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.channel.util.item.DirectionalLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.DirectionalLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.DirectionalLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.DirectionalLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.DirectionalLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.DirectionalLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.DirectionalLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.DirectionalLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.DirectionalLight.scene

type: property

modo.channel.util.item.DirectionalLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.DirectionalLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DirectionalLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.DirectionalLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.DirectionalLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.DomeLight

type: type

doc: Dome light item class Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Dome Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Dome Light item. :param light: Optional Dome light item object (type lx.symbol.sITYPE_DOMELIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Dome light item selected. :raises TypeError: if the item passed as an argument isn't either a Dome light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight._item

type: property

modo.channel.util.item.DomeLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.DomeLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.DomeLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.DomeLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.DomeLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.DomeLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.DomeLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.DomeLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.DomeLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.DomeLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.DomeLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.channel.util.item.DomeLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.DomeLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.DomeLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.DomeLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.DomeLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.DomeLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.DomeLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.DomeLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.DomeLight.scene

type: property

modo.channel.util.item.DomeLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.DomeLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.DomeLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.DomeLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.DomeLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Envelope

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Envelope.behavior

type: property

doc: gets/sets the behavior of times for both before the first keyframe and after the last keyframe in the envelope. :setter: Sets the envelope behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope behavior :rtype: int

modo.channel.util.item.Envelope.clear(self)

type: instancemethod

doc: Clears (removes all keys from) the envelope.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Envelope.interpolation

type: property

doc: Returns the interpolation setting for the envelope. Can be one of: | lx.symbol.iENVv_INTERP_CURVE | lx.symbol.iENVv_INTERP_LINEAR | lx.symbol.iENVv_INTERP_STEPPED :getter: Returns the interpolation setting for the envelope. :rtype: int

modo.channel.util.item.Envelope.isInt

type: property

doc: Returns whether the envelope is integer-valued type, if not it's a float type. :Getter: Returns True if the envelope is integer-valued type, False otherwise. :rtype: bool

modo.channel.util.item.Envelope.keyframes

type: property

doc: Returns a :class:`Keyframes` object that provides access to the keyframes set for the envelope and methods to manipulate them. :getter: Returns a :class:`Keyframes` object containing the keys for this envelope. :rtype: modo.channel.Keyframes

modo.channel.util.item.Envelope.postBehaviour

type: property

doc: gets/sets the behavior of times after the last keyframe in the envelope. :setter: Sets the envelope post behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope post behavior :rtype: int

modo.channel.util.item.Envelope.preBehaviour

type: property

doc: gets/sets the behavior of times before the first keyframe in the envelope. - **RESET** A default value, or may be just zero. - **CONSTANT** The value of the first or last keyframe. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **REPEAT** The values in the keyframe range repeating continuously. - **OSCILLATE** Like repeat, but the values run forwards and backward alternately. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **OFFSETREPEAT** Like repeat, but the values are offset in each cycle by the difference between the first and last keyframes. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **LINEAR** Linear interpolation from the slope at the nearest keyframe. - **NONE** Indicates that the envelope does not exist before or after the explicit keyframe range. This can be used by motion evaluation code to decide whether to use the envelope for a channel or to look up the parent envelope or default value. - **CONSTANT_KEEP_SLOPE** As for constant except that the slopes of the first or last keys are not changed. - **OSCILLATE_KEEP_SLOPE** As for oscillate except that the slopes of the first or last keys are not changed. - **OFFSETREPEAT_KEEP_SLOPE** As for offset repeat except that the slopes of the first or last keys are not changed. :setter: Sets the behavior :param behavior: the behaviour to set for the envelope. Can be one of: | lx.symbol.iENV_RESET | lx.symbol.iENV_CONSTANT | lx.symbol.iENV_REPEAT | lx.symbol.iENV_OSCILLATE | lx.symbol.iENV_OFFSETREPEAT | lx.symbol.iENV_LINEAR | lx.symbol.iENV_NONE | lx.symbol.iENV_CONSTANT_KEEP_SLOPE | lx.symbol.iENV_OSCILLATE_KEEP_SLOPE | lx.symbol.iENV_OFFSETREPEAT_KEEP_SLOPE :type behavior: int :getter: Returns envelope behavior :rtype: int

modo.channel.util.item.Envelope.value(self,time)

type: instancemethod

doc: Returns the value of the envelope evaluated at the specified time. If no time is explicitly provided the value of the envelope at the current time is returned :param time: time to evaluate envelope at. :type time: float :returns: value of the envelope :rtype: float for float type envelopes, int for integer-valued type envelopes

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.channel.util.item.GeneralInfluenceDeformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer._item

type: property

modo.channel.util.item.GeneralInfluenceDeformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.GeneralInfluenceDeformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.GeneralInfluenceDeformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.GeneralInfluenceDeformer.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.GeneralInfluenceDeformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.GeneralInfluenceDeformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.GeneralInfluenceDeformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.GeneralInfluenceDeformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.GeneralInfluenceDeformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.GeneralInfluenceDeformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.GeneralInfluenceDeformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.mapName

type: property

doc: :getter: Returns the UI version of the map name as string

modo.channel.util.item.GeneralInfluenceDeformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.channel.util.item.GeneralInfluenceDeformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.GeneralInfluenceDeformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.channel.util.item.GeneralInfluenceDeformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.GeneralInfluenceDeformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.GeneralInfluenceDeformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.GeneralInfluenceDeformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.scene

type: property

modo.channel.util.item.GeneralInfluenceDeformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.GeneralInfluenceDeformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GeneralInfluenceDeformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.GeneralInfluenceDeformer.svc

type: Deformer

modo.channel.util.item.GeneralInfluenceDeformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Group

type: type

doc: A group item. Takes an optional 'groupItem' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group' or an item name or ID to look up. If no groupItem is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. 'gtype' can be any one of the built in group types by passing one of the built in type strings ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader'), an empty string for a general group or any other string to create a custom group type. :param groupItem: an optional group item (type lx.symbol.sITYPE_GROUP) or an item name/ID to look up. :type groupItem: an instance of lx.object.Item, lxu.object.item or modo.item.Item :param gtype: the group type. :type gtype: basestring :raises TypeError: if an item is supplied as the groupItem argument but is not of type lx.symbol.sITYPE_GROUP. :raises ValueError: if no groupItem argument is supplied and no valid group item is selected in the scene. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found. Note that the children() method derived from the Item object will only list child groups. To iterate the contained items, use the method items.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group._item

type: property

modo.channel.util.item.Group._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.Group.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.Group.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.Group.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.Group.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.channel.util.item.Group.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.channel.util.item.Group.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.Group.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.Group.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.Group.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.Group.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.channel.util.item.Group.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.Group.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.Group.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.channel.util.item.Group.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.Group.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.Group.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.Group.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.Group.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.scene

type: property

modo.channel.util.item.Group.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.Group.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Group.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Group.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.channel.util.item.GroupLocator

type: type

doc: Group locator item class. Takes an optional 'grploc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group locator' or an item name or ID to look up. If no grploc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param grploc: Optional group locator item object (type lx.symbol.sITYPE_GROUPLOCATOR) or string (item name or ID) to look up. :type grploc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid group locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'group locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the grploc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator._item

type: property

modo.channel.util.item.GroupLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.GroupLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.GroupLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.GroupLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.GroupLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.GroupLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.GroupLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.GroupLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.GroupLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.GroupLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.GroupLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.GroupLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.GroupLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.GroupLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.GroupLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.GroupLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.GroupLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.GroupLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.GroupLocator.scene

type: property

modo.channel.util.item.GroupLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.GroupLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.GroupLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.GroupLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.GroupLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Item

type: type

doc: Base item class Takes an optional lx.object.Item object as an argument. If none is provided (the default) then the most recently selected item is used. :param item: Optional item object to wrap. :type item: an instance of lx.object.Item or lxu.object.item :raises ValueError: if no item is passed as an argument and no valid items are currently selected. :raises LookupError: if a string (item name or ID) is passed as the item argument and no item with that name or ID cane be found in the scene. :raises TypeError: if the object passed as the 'item' argument isn't an instance of lx.object.Item.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item._item

type: property

modo.channel.util.item.Item._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.Item.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.Item.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.Item.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.Item.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.Item.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.Item.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.Item.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.Item.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.Item.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.Item.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.Item.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.Item.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.Item.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.Item.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.scene

type: property

modo.channel.util.item.Item.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.Item.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Item.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Item.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.ItemGraph

type: type

doc: Utility container class for quick access to ItemGraph compatible graphs :param item: Item to look up graph for :param ls.symbol.sGRAPH_* graphType: Graph to look up. Common ones are 'parent', 'deformers', 'groups', 'chanMods' :param bool reverse: Indices traverse the graph forwards if false or reverse if true

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ItemGraph._ItemGraph__toType

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ItemGraph.connectedItems

type: property

doc: :getter: Returns a dictionary that lists the input- and output items at once. :rtype: dictionary

modo.channel.util.item.ItemGraph.connectInput(self,other)

type: instancemethod

doc: Connects the given item as input. This function is called by the >> operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ItemGraph.disconnectInput(self,other)

type: instancemethod

doc: Removes the given item from the input connections if any. This function is called by the << operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ItemGraph.forward(self,index)

type: instancemethod

doc: :returns list: Items of the forward connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ItemGraph.item

type: property

doc: :getter: Returns the Item that this ItemGraph instance is bound to. :return type: Item

modo.channel.util.item.ItemGraph.reverse(self,index)

type: instancemethod

doc: :returns list: Items of the reverse connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ItemGraph.setReverse(self,reverse)

type: instancemethod

doc: Sets the direction that is used for lookup when using the angular brackets [] :param bool reverse: If True the graph is looked up forwards, if False, backwards.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.ItemGraph.type

type: property

doc: :getter: Returns the name of the graph type that this instance represents. :return type: basestring

modo.channel.util.item.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.channel.util.item.Joint

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint._item

type: property

modo.channel.util.item.Joint._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.Joint.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.Joint.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.Joint.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.Joint.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.Joint.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.Joint.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.Joint.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.Joint.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.Joint.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.Joint.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.Joint.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.Joint.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.Joint.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.Joint.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Joint.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Joint.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Joint.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Joint.scene

type: property

modo.channel.util.item.Joint.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.Joint.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Joint.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Joint.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.Joint.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Keyframes

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Keyframes._indexFromTime(self,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Keyframes.add(self,val,time)

type: instancemethod

doc: Adds a new keyframe at the specified time. If no time value is passed as an argument a keyframe is set at the current time. :param time: optional time (in seconds) to add a keyframe at. :type time: float :param val: the value to set for the keyframe :type val: int or float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Keyframes.delete(self)

type: instancemethod

doc: Deletes the current key

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Keyframes.first(self)

type: instancemethod

doc: Go to the first keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Keyframes.getSlopeType(self,side)

type: instancemethod

doc: Returns the slope type for either side of a keyframe. :returns: a tuple of the slope type set for the side of the keyframe specified and whether the slope is weighted or not. :rtype: (int, int)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Keyframes.last(self)

type: instancemethod

doc: Go to the last keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Keyframes.next(self)

type: instancemethod

doc: Go to the next keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Keyframes.numKeys

type: property

doc: :getter: Returns the number of keyframes found :rtype: int

modo.channel.util.item.Keyframes.prev(self)

type: instancemethod

doc: Go to the previous keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Keyframes.setIndex(self,index)

type: instancemethod

doc: Go to the keyframe by index

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Keyframes.setSlopeType(self,stype,side)

type: instancemethod

doc: Sets the slope type for either side of a keyframe - **SLOPE_DIRECT** the slope of the tangent is set based on the value stored in the key. - **SLOPE_AUTO** the slope of the tangent is calculated automatically with regard to surrounding keys. This is similar to the slope adjustments made by TCB curves. - **SLOPE_LINEAR_IN** the slope of the tangent is calculated to align with the previous key's value. - **SLOPE_LINEAR_OUT** the slope of the tangent is calculated to align with the next key's value. - **SLOPE_FLAT** The slope of the tangent is set to zero. - **SLOPE_AUTOFLAT** the same as auto but if a neighboring key has the same value as the key the slope is set to zero. - **SLOPE_STEPPED** Maintains the value of the previous key between pairs of keys. :param stype: set the slope type for the current keyframe. Can be one of: | lx.symbol.iSLOPE_AUTO | lx.symbol.iSLOPE_AUTOFLAT | lx.symbol.iSLOPE_DIRECT | lx.symbol.iSLOPE_FLAT | lx.symbol.iSLOPE_LINEAR_IN | lx.symbol.iSLOPE_LINEAR_OUT | lx.symbol.iSLOPE_STEPPED :type stype: int :param side: the side of the key (in or out) the slope type is being set for :type side: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.Keyframes.time

type: property

doc: Returns & sets the time for the current keyframe. :setter: Sets the time :param time: the time to move the key to. :type time: float :getter: Returns the time of the current keyframe :rtype: float

modo.channel.util.item.Keyframes.value

type: property

doc: Convenience property to get & set value of the current keyframe for the 90% case of an unbroken key. :setter: Sets a value :param val: the value to set for the key. :type val: int or float :getter: Returns the value of an (unbroken) key. :rtype: int or float

modo.channel.util.item.Light

type: type

doc: Base Light item class. Each light item encapsulates both an lx.object.Item object (via inheritance from the Item class) of a specific modo light type and a corresponding lx.object.Item of type 'lightMaterial' as a :class:`LightMaterial` object via the light's material property. example:: # to set the diffuse color on the currently selected spotlight spotlight = modo.SpotLight() spotlight.material.ch_diffCol.set((0.7, 0.1, 0.5)) .. note:: Although "Light" isn't technically a base class since, like all other classes in modo.item, it inherits from "Item", it does encapsulate modo's 'Light" supertype and can be treated as a kind of 'pseudo' base class for all modo's light types. As such it should not be instantiated directly, create one of the specific light types instead. | :param light: Optional light item object to wrap. Must be a specific type of light, not the light supertype. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid light item selected. :raises TypeError: if the item passed as an argument isn't an instance of a specific subclass of Light.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light._item

type: property

modo.channel.util.item.Light._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.Light.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.Light.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.Light.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.Light.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.Light.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.Light.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.Light.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.Light.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.Light.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.Light.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.channel.util.item.Light.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.Light.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.Light.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.Light.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.Light.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Light.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Light.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Light.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Light.scene

type: property

modo.channel.util.item.Light.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.Light.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Light.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Light.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.Light.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.LightMaterial

type: type

doc: Wraps a light material texture layer item. :param material: the light material item to be wrapped. :type material: lx.object.Item of type lx.symbol.sITYPE_LIGHTMATERIAL

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial._item

type: property

modo.channel.util.item.LightMaterial._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.LightMaterial.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.LightMaterial.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.LightMaterial.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.LightMaterial.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.LightMaterial.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.LightMaterial.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.LightMaterial.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.LightMaterial.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.LightMaterial.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.LightMaterial.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.light

type: property

doc: :getter: The light item that the material belongs to. :param light_item: the light item to parent the material layer to. :type light_item: an instance of one of the modo.Light types or either lx.object.Item or lxu.object.Item of a specific light item type :returns: the parent light item. :rtype: one of the modo light types.

modo.channel.util.item.LightMaterial.lightCol

type: property

doc: A wrapper property for the light material item's three diffuse color channels. Returns an :class:`modo.channel.Channel` object :getter: Returns a channelTriple object. :rtype: modo.channel.channelTriple

modo.channel.util.item.LightMaterial.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.LightMaterial.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.LightMaterial.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.LightMaterial.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.LightMaterial.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.scatteringCol

type: property

doc: :getter: A wrapper property for the light material item's three scattering color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.channel.util.item.LightMaterial.scene

type: property

modo.channel.util.item.LightMaterial.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.LightMaterial.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LightMaterial.shadCol

type: property

doc: :getter: A wrapper property for the light material item's three shadow color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.channel.util.item.LightMaterial.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.LightMaterial.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Locator

type: type

doc: Locator item class. Takes an optional 'locator' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'locator' or an item name or ID to look up. If no locator item is supplied as an argument an attempt will be made to wrap the most recently selected locator item. :param locator: Optional locator item object (type lx.symbol.sITYPE_LOCATOR) or string (item name or ID) to look up. :type locator: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the locator argument but no item with that name/ID can be found. Hint: Items of other locator derived types should be casted as LocatorSuperType, casting to this class will fail.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator._item

type: property

modo.channel.util.item.Locator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.Locator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.Locator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.Locator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.Locator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.Locator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.Locator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.Locator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.Locator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.Locator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.Locator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.Locator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.Locator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.Locator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.Locator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Locator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Locator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Locator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Locator.scene

type: property

modo.channel.util.item.Locator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.Locator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Locator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Locator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.Locator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.LocatorSuperType

type: type

doc: The LocatorSuperType reflects all items that can be seen and transformed in the 3d view. Locators have transform items that hold the respective transform channels, such as position and rotation.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType._item

type: property

modo.channel.util.item.LocatorSuperType._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.LocatorSuperType.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.LocatorSuperType.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.LocatorSuperType.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.LocatorSuperType.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.LocatorSuperType.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.LocatorSuperType.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.LocatorSuperType.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.LocatorSuperType.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.LocatorSuperType.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.LocatorSuperType.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.LocatorSuperType.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.LocatorSuperType.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.LocatorSuperType.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.LocatorSuperType.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.LocatorSuperType.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.LocatorSuperType.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.LocatorSuperType.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.LocatorSuperType.scene

type: property

modo.channel.util.item.LocatorSuperType.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.LocatorSuperType.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.LocatorSuperType.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.LocatorSuperType.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.LocatorSuperType.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Matrix4

type: type

doc: Matrix class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4._getIdentity

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4._matrix_calcRotation

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4._matrix_vectorMultiply

type: function

doc: :param matrix: :param vector: :param result: :return:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4._MatrixToEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4._rotOrderToList

type: function

doc: takes a string in form of 'xyz' and returns a list in form of [0,1,2]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4.asEuler(self,degrees,order)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4.asRotateMatrix(self)

type: instancemethod

doc: Removes the translation part of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4.copy(self)

type: instancemethod

doc: :return: A copy of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4.determinant(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4.fromEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4.invert(self)

type: instancemethod

doc: Inverts this Matrix in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4.inverted(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4.position

type: property

doc: :getter: Returns the translation part of this matrix :rtype: tuple :setter: Sets the translation part of this matrix :param position: Position :type position: iterable

modo.channel.util.item.Matrix4.scale(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4.set(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4.setIdentity(self)

type: instancemethod

doc: Set this matrix to it's identity

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4.transpose(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Matrix4.transposed(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal. It returns a new transposed matrix.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Mesh

type: type

doc: Mesh item class. Takes an optional 'mesh' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'mesh' or an item name or ID to look up. If no mesh item is supplied as an argument an attempt will be made to wrap the most recently selected mesh layer. :param mesh: Optional mesh item object (type lx.symbol.sITYPE_MESH) or string (item name or ID) to look up. :type mesh: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid mesh item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'mesh' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the mesh argument but no item with that name/ID can be found. The mesh geometry can be accessed by the :class:`geometry` attribute. .. py:attribute:: geometry :rtype: :class:`MeshGeometry`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh._item

type: property

modo.channel.util.item.Mesh._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.Mesh.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.Mesh.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.Mesh.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.Mesh.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.geometry

type: property

modo.channel.util.item.Mesh.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.Mesh.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.Mesh.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.Mesh.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.Mesh.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.Mesh.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.Mesh.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.Mesh.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.Mesh.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.Mesh.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.Mesh.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Mesh.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Mesh.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Mesh.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Mesh.scene

type: property

modo.channel.util.item.Mesh.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.Mesh.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Mesh.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Mesh.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.Mesh.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.MeshGeometry

type: type

doc: A class wrapped around lx.object.Mesh that provides access to geometry of a given Mesh Item :param item: Input item :type item: type lx.object.Item :param mode: Mode in which to access the mesh. Possible values: "write", "read", "deformed" :type mode: string. Note: References are always read only. :return: Instance of MeshGeometry :raises LookupError: If item was passed as string and could not be found in the scene :raises TypeError: If the passed item is not of type lx.object.Item :raises TypeError: If the passed item is not compatible with the mesh type example:: scene = modo.scene.current() # Get the selected mesh for mesh in scene.selectedByType("mesh")[:1]: # Print the number of vertices print len(mesh.geometry.vertices) # Print point position by index print mesh.geometry.vertices[4] # Set point position by index mesh.geometry.vertices[4] = (1,2,3) # Iterate all vertices and move them by 0.1 in x for point in mesh.geometry.vertices: point += (0.1, 0, 0) # Update to see mesh changes mesh.geometry.setMeshEdits() .. py:attribute:: vertices :rtype: :class:`MeshVertices` .. py:attribute:: edges :rtype: :class:`MeshEdges` .. py:attribute:: polygons :rtype: :class:`MeshPolygons` .. py:attribute:: vmaps :rtype: :class:`MeshMaps`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.channel.util.item.MeshGeometry._item

type: property

modo.channel.util.item.MeshGeometry._SEL_SVC

type: Selection

modo.channel.util.item.MeshGeometry._UNDO_SVC

type: Undo

modo.channel.util.item.MeshGeometry.accessMode

type: property

modo.channel.util.item.MeshGeometry.boundingBox

type: property

doc: Get the bounding box of this mesh :getter: Returns a tuple representing the two corners of the bounding box

modo.channel.util.item.MeshGeometry.getMeshCenter(self)

type: instancemethod

doc: :return: Center position of the bounding box

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.channel.util.item.MeshGeometry.internalMesh

type: property

doc: :getter: Returns the wrapped lx.object.Mesh object

modo.channel.util.item.MeshGeometry.numEdges

type: property

doc: :getter: returns the vertex count of this mesh

modo.channel.util.item.MeshGeometry.numPolygons

type: property

doc: :getter: returns the polygon count of this mesh

modo.channel.util.item.MeshGeometry.numVertices

type: property

doc: :getter: returns the vertex count of this mesh

modo.channel.util.item.MeshGeometry.setAccessMode(self,value,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.channel.util.item.MeshGeometry.setMeshEdits(self,editType)

type: instancemethod

doc: Updates mesh edits applying previous changes. :param lx.symbol.f_MESHEDIT_* editType: The type of change to set. Defaults to all.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.channel.util.item.PhotometricLight

type: type

doc: Photometric (ies) light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Photometric Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Photometric Light item. :param light: Optional Photometric light item object (type lx.symbol.sITYPE_PHOTOMETRYLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Photometric light item selected. :raises TypeError: if the item passed as an argument isn't either a Photometric light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight._item

type: property

modo.channel.util.item.PhotometricLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.PhotometricLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.PhotometricLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.PhotometricLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.PhotometricLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.PhotometricLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.PhotometricLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.PhotometricLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.PhotometricLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.PhotometricLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.PhotometricLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.channel.util.item.PhotometricLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.PhotometricLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.PhotometricLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.PhotometricLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.PhotometricLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.PhotometricLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.PhotometricLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.PhotometricLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.PhotometricLight.scene

type: property

modo.channel.util.item.PhotometricLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.PhotometricLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PhotometricLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.PhotometricLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.PhotometricLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.PointLight

type: type

doc: Point light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Point Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Point Light item. :param light: Optional Point light item object (type lx.symbol.sITYPE_POINTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Point light item selected. :raises TypeError: if the item passed as an argument isn't either a Point light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight._item

type: property

modo.channel.util.item.PointLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.PointLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.PointLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.PointLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.PointLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.PointLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.PointLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.PointLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.PointLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.PointLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.PointLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.channel.util.item.PointLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.PointLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.PointLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.PointLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.PointLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.PointLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.PointLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.PointLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.PointLight.scene

type: property

modo.channel.util.item.PointLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.PointLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.PointLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.PointLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.PointLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Portal

type: type

doc: Portal item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Portal' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Portal item. :param light: Optional Portal item object (type 'portal') or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Portal item selected. :raises TypeError: if the item passed as an argument isn't either a Portal item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal._item

type: property

modo.channel.util.item.Portal._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.Portal.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.Portal.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.Portal.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.Portal.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.Portal.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.Portal.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.Portal.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.Portal.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.Portal.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.Portal.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.channel.util.item.Portal.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.Portal.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.Portal.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.Portal.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.Portal.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Portal.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Portal.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Portal.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.Portal.scene

type: property

modo.channel.util.item.Portal.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.Portal.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.Portal.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.Portal.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.Portal.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.RenderPassGroup

type: type

doc: Render pass group :param groupItem: either a group item or an item name/ID to look up. :type groupItem: lx.object.item or modo.item.Item :raises TypeError: if the item is not a 'Group" item. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup._item

type: property

modo.channel.util.item.RenderPassGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.addPass(self,name)

type: instancemethod

doc: Add a render pass item to the group. :param name: optional name for the render pass :type name: basestring :return: the render pass item. :rtype: modo.item.ActionClip

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.RenderPassGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.RenderPassGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.RenderPassGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.RenderPassGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.channel.util.item.RenderPassGroup.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.channel.util.item.RenderPassGroup.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.RenderPassGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.RenderPassGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.RenderPassGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.RenderPassGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.channel.util.item.RenderPassGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.RenderPassGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.RenderPassGroup.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.channel.util.item.RenderPassGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.RenderPassGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.RenderPassGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.RenderPassGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.RenderPassGroup.passes

type: property

doc: :getter: Returns a lst of render passes in the group. :returns: list of render pass items :rtype: list of modo.item.ActionClip

modo.channel.util.item.RenderPassGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.scene

type: property

modo.channel.util.item.RenderPassGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.RenderPassGroup.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.RenderPassGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.RenderPassGroup.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.channel.util.item.scene

type: module

doc: .. module:: modo.scene :synopsis: Scene class and scene level utility functions. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.channel.util.item.scene.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.channel.util.item.scene.ChannelRead contents:
  • modo.channel.util.item.scene.ChannelRead.__class__
  • modo.channel.util.item.scene.ChannelRead.__delattr__
  • modo.channel.util.item.scene.ChannelRead.__dict__
  • modo.channel.util.item.scene.ChannelRead.__doc__
  • modo.channel.util.item.scene.ChannelRead.__format__
  • modo.channel.util.item.scene.ChannelRead.__getattr__
  • modo.channel.util.item.scene.ChannelRead.__getattribute__
  • modo.channel.util.item.scene.ChannelRead.__hash__
  • modo.channel.util.item.scene.ChannelRead.__init__
  • modo.channel.util.item.scene.ChannelRead.__module__
  • modo.channel.util.item.scene.ChannelRead.__new__
  • modo.channel.util.item.scene.ChannelRead.__reduce__
  • modo.channel.util.item.scene.ChannelRead.__reduce_ex__
  • modo.channel.util.item.scene.ChannelRead.__repr__
  • modo.channel.util.item.scene.ChannelRead.__setattr__
  • modo.channel.util.item.scene.ChannelRead.__sizeof__
  • modo.channel.util.item.scene.ChannelRead.__str__
  • modo.channel.util.item.scene.ChannelRead.__subclasshook__
  • modo.channel.util.item.scene.ChannelRead.__weakref__
  • modo.channel.util.item.scene.ChannelRead.set

modo.channel.util.item.scene.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.scene.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.channel.util.item.scene.ChannelWrite contents:
  • modo.channel.util.item.scene.ChannelWrite.__class__
  • modo.channel.util.item.scene.ChannelWrite.__delattr__
  • modo.channel.util.item.scene.ChannelWrite.__dict__
  • modo.channel.util.item.scene.ChannelWrite.__doc__
  • modo.channel.util.item.scene.ChannelWrite.__format__
  • modo.channel.util.item.scene.ChannelWrite.__getattr__
  • modo.channel.util.item.scene.ChannelWrite.__getattribute__
  • modo.channel.util.item.scene.ChannelWrite.__hash__
  • modo.channel.util.item.scene.ChannelWrite.__init__
  • modo.channel.util.item.scene.ChannelWrite.__module__
  • modo.channel.util.item.scene.ChannelWrite.__new__
  • modo.channel.util.item.scene.ChannelWrite.__reduce__
  • modo.channel.util.item.scene.ChannelWrite.__reduce_ex__
  • modo.channel.util.item.scene.ChannelWrite.__repr__
  • modo.channel.util.item.scene.ChannelWrite.__setattr__
  • modo.channel.util.item.scene.ChannelWrite.__sizeof__
  • modo.channel.util.item.scene.ChannelWrite.__str__
  • modo.channel.util.item.scene.ChannelWrite.__subclasshook__
  • modo.channel.util.item.scene.ChannelWrite.__weakref__
  • modo.channel.util.item.scene.ChannelWrite.set

modo.channel.util.item.scene.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.channel.util.item.scene.current

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.channel.util.item.scene.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.scene.Scene

type: type

doc: The main scene class. Takes an optional lx.object.Scene object as an argument. If none is provided (the default) then the currently selected scene is used which will mostly be the general case. The module function :func:`sceneList` makes use of the scene parameter to return a list of open scenes as modo.scene.Scene objects. :param scene: Optional scene object to wrap. :type scene: lx.object.Scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene._allItems(self)

type: instancemethod

doc: Utility function to get all items of a scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene._Scene__ItemAdd(self,groupType)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene._Scene__setupTextureLayerType(self,newItem)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.actors

type: property

doc: Returns a list of all actors in the scene :getter: Returns a list of Actor objects found in this scene :rtype: list

modo.channel.util.item.scene.Scene.addActor(self,name,items,makeActive)

type: instancemethod

doc: Add a new actor to the scene :returns modo.item.Actor: Actor item object :param basestring name: optional name :param list items: list of items for the actor to contain

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.addCamera(self,name)

type: instancemethod

doc: Add a new camera item to the scene :returns: camera item :rtype: modo.item.Camera :param name: optional name for the camera. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.addGroup(self,name,gtype)

type: instancemethod

doc: Add a new group item to the scene :returns: group item :rtype: modo.item.Group :param name: optional name for the group item. :type name: basestring :param gtype: optional group type, can be one of the default group types ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader') or any other string to create a custom group type. Default is an empty string which creates a 'Genera' group type. :type gtype: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.addItem(self,itype,name)

type: instancemethod

doc: Add a new item to the scene :returns: item :rtype: modo.item.item :param itype: item type :type itype: modo.Constant :param name: optional name for the item. :type name: basestring :raises TypeError: When failing

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.addJointLocator(self,name,parent)

type: instancemethod

doc: Adds a new joint to the scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.addMaterial(self,matType,name,index)

type: instancemethod

doc: Adds a new material to the scene :param modo.c.MATERIAL_* matType: Type of material to create :param name: Optional name for the material :returns Item: The material item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.addMesh(self,name)

type: instancemethod

doc: Add a new mesh item to the scene :returns: mesh item :rtype: modo.item.Mesh :param name: optional name for the mesh. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.addRenderPassGroup(self,name)

type: instancemethod

doc: Add a render pass group to the scene :returns: render pass group. :rtype: modo.item.RenderPassGroup :param name: optional name for the render pass group. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.camera(self,cam)

type: instancemethod

doc: Returns a camera item in the scene. The supplied argument can be either a string (camera ID or name) or an integer (camera index in the scene's collection of cameras) :param cam: the camera :type cam: basestring or int :returns: camera item :rtype: modo.item.Camera

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.cameraCount

type: property

doc: Number of cameras in the scene. :getter: Returns the number of camera items. :rtype: int

modo.channel.util.item.scene.Scene.cameras

type: property

doc: Returns a list of all the camera items in the scene as modo.item.Camera objects. :getter: Returns a list of the camera items in the scene. :rtype: list of modo.item.Camera

modo.channel.util.item.scene.Scene.currentRange

type: property

doc: Set or read the current frame range start and end frame value should be passed in as a tuple. :setter: Sets the range :param frange: frame range - a tuple of ints (start, end). :type frange: tuple :Getter: Returns the start and end frames. :rtype: tuple :exception ValueError: if supplied start frame is higher than end frame.

modo.channel.util.item.scene.Scene.deformers(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.deselect(self,itemObj)

type: instancemethod

doc: Deselect an item. :param itemObj: the item to deselect. Clears the entire selection if None :type itemObj: basestring (item name or ID) or instance of either lx.object.Item or modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.duplicateItem(self,item,instance)

type: instancemethod

doc: Creates and returns a duplicate of the passed item :returns item: Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.filename

type: property

doc: File path of the scene. :getter: Returns the file path of the scene or 'None' if not yet saved. :rtype: basestring or None

modo.channel.util.item.scene.Scene.fps

type: property

doc: Scene frames per second. .. note:: There is no way to set the fps value from the Python API for any scene other than the currently selected one. Therefore, for any other scene the property will be read only and attempts to write to it will throw an AttributeError. | :getter: Returns the Frames Per Second :rtype: float :setter: Sets the Frames Per Second :param fps: Scene frames per second. :type fps: float :raises: AttributeError

modo.channel.util.item.scene.Scene.getGroups(self,gtype)

type: instancemethod

doc: Returns all groups of the given kind :param gtype: optional group type, can be one of the default group types ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader') or any other string to create a custom group type. Default is an empty string which creates a 'Genera' group type. You can also pass a list of multiple group types. :returns list: List of groups matching the type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.groups

type: property

doc: Returns a list of all the group items in the scene as modo.item.Group objects. :getter: Returns a list of the group items in the scene. :rtype: list of modo.item.Group

modo.channel.util.item.scene.Scene.item(self,name)

type: instancemethod

doc: Look up item by name :param string item: Name to look for :returns item: Found item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.itemCount(self,itype)

type: instancemethod

doc: The number of items of a specified type in the scene. :param itype: type of the items. :type itype: int or basestring :returns: the number of items of the specified type in the scene. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.items(self,itype,name,superType)

type: instancemethod

doc: List of items of the specified type in the scene. :param itype: the item type. :type itype: :param basestring name: Optionally filter result by this text. Can use * and ? wildcards for globbing. :param bool superType: If True, all items that have 'itype' as superType are listed. Else, only items of specifically that type are returned. :returns: list of the items of the specified type in the scene. If itype is None, all items in the scene are returned. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.iterItems(self,itype,name,superType)

type: instancemethod

doc: Same as items(), but returns a generator object.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.lightCount

type: property

doc: Number of lights in the scene. :getter: Returns the number of light items. :rtype: int

modo.channel.util.item.scene.Scene.locators

type: property

modo.channel.util.item.scene.Scene.meshCount

type: property

doc: Number of mesh items in the scene. :getter: Returns the number of mesh items. :rtype: int

modo.channel.util.item.scene.Scene.meshes

type: property

doc: Returns a list of all the mesh items in the scene as modo.item.Mesh objects. :getter: Returns a list of the mesh items in the scene. :rtype: list of modo.item.Mesh

modo.channel.util.item.scene.Scene.name

type: property

doc: Friendly name of the scene. :getter: Returns the name of the scene. :rtype: basestring

modo.channel.util.item.scene.Scene.removeItems(self,itm,children)

type: instancemethod

doc: :param Item: Item to remove from the scene :param bool children: If True, all found children are deleted also

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.renderCamera

type: property

doc: Get & set the scene's current render camera :setter: Set the scene's current render camera :param camera: the camera item to set as the current render camera. :type camera: lx.object.Item of type 'Camera' :getter: Returns the current render camera. :rtype: modo.Item.Camera

modo.channel.util.item.scene.Scene.renderItem

type: property

doc: :getter: Returns the first found render item of the scene :rtype: Item

modo.channel.util.item.scene.Scene.renderPassGroups

type: property

doc: Returns a list of all the render pass group items in the scene as modo.item.RenderPassGroup objects. :getter: Returns a list of the render pass group items in the scene. :rtype: list of modo.item.Group

modo.channel.util.item.scene.Scene.sceneItem

type: property

doc: The scene's 'scene item' :getter: Returns the scene's scene item. :rtype: lxdt.item.Item (type lx.symbol.sITYPE_SCENE)

modo.channel.util.item.scene.Scene.sceneRange

type: property

doc: Set or read the scene's frame range start and end frame value should be passed in as a tuple. :setter: Sets the range :param frange: frame range - a tuple of ints (start, end). :type frange: tuple :getter: Returns the start and end frames. :rtype: tuple :exception ValueError: if supplied start frame is higher than end frame.

modo.channel.util.item.scene.Scene.select(self,itemObj,add)

type: instancemethod

doc: :param itemObj: the item to select. :type item: basestring (item name or ID) or instance of either lx.object.Item or modo.item.Item :param add: whether to add to the current selection, False replaces the current selection. :type add: bool Note:: To clear the selection of the scene, please use deselect() instead.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.Scene.selected

type: property

doc: Selected items in the scene. :getter: Returns the selected items :rtype: list

modo.channel.util.item.scene.Scene.selectedByType(self,itype,superType)

type: instancemethod

doc: Returns the selected items of a specific type as modo.item.Item objects. :param itype: item type to filter on. :type itype: int or string :return: selcted items of specified type. :param bool superType: If True, all items derived fom itype are listed. Otherwise only items of the exact type of itype. :rtype: list of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.sceneList

type: function

doc: Get a list of all the currently open scenes. :returns: Collection of currently open scenes as modo.scene.Scene objects. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.channel.util.item.scene.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.channel.util.item.SpotLight

type: type

doc: Spotlight item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Spotlight' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Spotlight item. :param light: Optional Spotlight item object (type lx.symbol.sITYPE_SPOTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Spotlight item selected. :raises TypeError: if the item passed as an argument isn't either a Spotlight item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight._item

type: property

modo.channel.util.item.SpotLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.SpotLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.SpotLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.SpotLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.SpotLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.SpotLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.SpotLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.SpotLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.SpotLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.SpotLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.SpotLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.channel.util.item.SpotLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.SpotLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.SpotLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.SpotLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.SpotLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.SpotLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.SpotLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.SpotLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.SpotLight.scene

type: property

modo.channel.util.item.SpotLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.SpotLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.SpotLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.SpotLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.SpotLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.TextureLocator

type: type

doc: Texture locator item class. Takes an optional 'texloc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Texture locator' or an item name or ID to look up. If no texloc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param texloc: Optional texture locator item object (type lx.symbol.sITYPE_TEXTURELOC) or string (item name or ID) to look up. :type texloc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid texture locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'texture locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the texloc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator._item

type: property

modo.channel.util.item.TextureLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.TextureLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.TextureLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.TextureLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.TextureLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.TextureLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.TextureLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.TextureLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.TextureLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.TextureLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.TextureLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.TextureLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.TextureLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.TextureLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.TextureLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.TextureLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.TextureLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.TextureLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.TextureLocator.scene

type: property

modo.channel.util.item.TextureLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.TextureLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TextureLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.TextureLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.TextureLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.TransformItem

type: type

doc: Contains a group of animatable transform channels of a locator object. It has convenience functions for access of the locator's position, rotation and scale. examples:: # We retrieve two meshes from the current scene by name, assuming they exist cube = modo.Mesh('Cube') sphere = modo.Mesh('Sphere') # Set rotation values cube.rotation.set(10, 20, 30, degrees=True) # Link the position.x channel of the sphere to to the position.x channel of the cube cube.position.y.setLink(0, sphere.position.x, 0) # Set position values to zero cube.position.clear() # Insert keyframe for rotation on frame 21 frame = lx.service.Value().FrameToTime(21) cube.rotation.insertKey(time=frame)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem._item

type: property

modo.channel.util.item.TransformItem._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem._TransformItem__rotationType

type: long

modo.channel.util.item.TransformItem._TransformItem__scaleType

type: long

modo.channel.util.item.TransformItem._TransformItem__toDegrees

type: function

doc: Utility function to consume and process the 'degrees' argument for the set function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem._TransformItem__transformType(self)

type: instancemethod

doc: Utility function that returns the corresponding string value from __types, for later channel lookup

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem._TransformItem__translationType

type: long
modo.channel.util.item.TransformItem._TransformItem__types type: dict

modo.channel.util.item.TransformItem._TransformItem__types.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.channel.util.item.TransformItem._TransformItem__types.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.channel.util.item.TransformItem._TransformItem__types.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.channel.util.item.TransformItem._TransformItem__types.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.channel.util.item.TransformItem._TransformItem__types.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.channel.util.item.TransformItem._TransformItem__types.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.channel.util.item.TransformItem._TransformItem__types.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.channel.util.item.TransformItem._TransformItem__types.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.channel.util.item.TransformItem._TransformItem__types.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.channel.util.item.TransformItem._TransformItem__types.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.channel.util.item.TransformItem._TransformItem__types.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.channel.util.item.TransformItem._TransformItem__types.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.channel.util.item.TransformItem._TransformItem__types.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.channel.util.item.TransformItem._TransformItem__types.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.channel.util.item.TransformItem._TransformItem__types.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.channel.util.item.TransformItem._TransformItem__types.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.channel.util.item.TransformItem._TransformItem__types.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.channel.util.item.TransformItem._TransformItem__types.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.channel.util.item.TransformItem.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.TransformItem.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.TransformItem.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.clear(self)

type: instancemethod

doc: Sets values to 1.0 if is a scaling transform and to 0.0 otherwise :param arguments: Same as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.TransformItem.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.TransformItem.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.get(self,time,action,degrees)

type: instancemethod

doc: Function to get the x, y and z-values of the locator at once. :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when getting rotation. :param keywords: Same as as :meth:`Channel.get` :returns tuple: x, y and z values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.TransformItem.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.TransformItem.insertKey(self,time,action)

type: instancemethod

doc: Inserts a keyframe on the respective x, y and z channels. :param float time: Time in seconds to create the new keys :param action: Action to create keys in.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.TransformItem.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.TransformItem.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.TransformItem.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.TransformItem.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.TransformItem.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.TransformItem.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.TransformItem.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.TransformItem.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.removeKey(self,time,action)

type: instancemethod

doc:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.scene

type: property

modo.channel.util.item.TransformItem.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.TransformItem.set(self,values,time,key,action,degrees)

type: instancemethod

doc: Function to set the x, y and z-values of the locator at once. :param values: either three floats, or a list/tuple containing the x, y, z values to set :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when setting rotation. :param keywords: Same as as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItem.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.TransformItem.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.TransformItem.x

type: property

doc: Shortcut to the x channel of the locator :getter: :class:`Channel` :rtype: float

modo.channel.util.item.TransformItem.y

type: property

doc: Shortcut to the y channel of the locator :getter: :class:`Channel` :rtype: float

modo.channel.util.item.TransformItem.z

type: property

doc: Shortcut to the z channel of the locator :getter: :class:`Channel` :rtype: float

modo.channel.util.item.TransformItems

type: type

doc: Container class for the stacked transform items of a Locator object. Transform items contain channels for either position, rotation or scale. The order of how they are processed can be changed and new transform items can be inserted or existing ones deleted. example:: scene = modo.scene.current() # Grab first selected object for item in scene.selected[:1]: # Print the amount of transform items print len(item.transforms) # Add a new position transform item position = item.transforms.insert('position', values=(1,0,0), name='New_Position') # Add a new scale transform item scale = item.transforms.insert('scale', values=(2,2,2), name='Scaled') # Swap the indices of the first two transform items item.transforms.reposition(0,1) # Delete item.transforms.delete(scale) # Clear values of all transforms for i in item.transforms: i.clear()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems._item

type: property

modo.channel.util.item.TransformItems._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.channel.util.item.TransformItems.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.channel.util.item.TransformItems.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.channel.util.item.TransformItems.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.channel.util.item.TransformItems.delete(self,index)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.channel.util.item.TransformItems.idNames(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.channel.util.item.TransformItems.insert(self,xfrmType,placement,values,name)

type: instancemethod

doc: Insert a new transform item into the transform chain. The 'prepend' and 'append' placement values place the new item at the top or bottom of the stack, where 'pre' and 'post' place it around the respective transform highlighted in black in the channel view. I am myself confused about the order though, is it bottom to top or the other way around? Note that modo always keeps at least one of each type of transform, so when you attempt to delete it a new one is created automatically. :param string xfrmType: 'position', 'rotation' or 'scale' :param string placement: 'prepend', 'append', 'pre' or 'post' :param tuple values: Initial xyz values to be optionally set :param string name: Optional name

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.channel.util.item.TransformItems.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.channel.util.item.TransformItems.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.channel.util.item.TransformItems.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.channel.util.item.TransformItems.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.channel.util.item.TransformItems.names(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.channel.util.item.TransformItems.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.channel.util.item.TransformItems.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.channel.util.item.TransformItems.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.TransformItems.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.TransformItems.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.reposition(self,indexFrom,indexTo)

type: instancemethod

doc: Places a transform item to the provided index of the transform item stack :param int indexFrom: Source Index of the item that is to be moved :param int indexTo: Destination index to place item at

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.TransformItems.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.channel.util.item.TransformItems.scene

type: property

modo.channel.util.item.TransformItems.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.channel.util.item.TransformItems.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.channel.util.item.TransformItems.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.TransformItems.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.channel.util.item.TransformItems.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.channel.util.item.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.channel.util.item.Vector3

type: type

doc: Vector3 class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.angle(self,other)

type: instancemethod

doc: Returns the angle between this and another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.copy(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.cross(self,other)

type: instancemethod

doc: Returns a new vector with the result of crossing this vector with another

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.distanceBetweenPoints(self,other)

type: instancemethod

doc: Returns the distance between this and another point

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.dot(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.equals(self,other,tolerance)

type: instancemethod

doc: Returns if this vector is equivalent to another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.length(self)

type: instancemethod

doc: Returns the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.mulByMatrixAsPoint(self,other)

type: instancemethod

doc: Transform this point's position by a Matrix4 in place. :param Matrix4 other: Other Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.normal(self)

type: instancemethod

doc: Returns a normalized copy of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.normalize(self)

type: instancemethod

doc: Normalizes this vector in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.rotate(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.rotateByAxisAngle(self,axis,angle)

type: instancemethod

doc: Rotates this vector by a given axis and angle :param Vector3 axis: This axis to rotate about :param float angle: The angle in radians to rotate by

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.rotateByQuat(self,other)

type: instancemethod

doc: Rotate this vector by a quaternion

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.setLength(self,value)

type: instancemethod

doc: Sets the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.channel.util.item.Vector3.x

type: property

doc: Quick access to the x component of the vector

modo.channel.util.item.Vector3.y

type: property

doc: Quick access to the y component of the vector

modo.channel.util.item.Vector3.z

type: property

doc: Quick access to the z component of the vector

modo.channel.util.makeQuickCommand

type: function

doc: Quick way to create a command. Note that a command can only be blessed (registered) once per modo session, so this command will fail when attempting to rebless a command. :param string name: Name that the command will be callable by. Example: cmds.myCommand :param function func: The function that the command should call :param iterable arguments: A sequence of name:defaultvalue pairs to make arguments that will be passed on to the function :param basestring userName: The user name :param basestring description: Summary of the command's purpose :param basestring toolTip: Text that appears when hovering over the button example:: import modo def func_args(mystring, myint): print mystring, myint def func_simple(): print 'simple function, no arguments' modo.util.makeQuickCommand('test.simple', func_simple) modo.util.makeQuickCommand('test.args', func_args, (('mystring', 'mesh021'), ('myint', 23))) lx.eval('test.simple') lx.eval('test.args mesh022 24')

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.channel.util.paths

type: function

doc: Access to various system paths. :param basestring key: Specific path to return. Returns all if None. :returns dictionary or string: Dictionary containing all paths or single path as string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.channel.util.testGlobalInterpreter

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.channel.util.typeToFunc

type: function

doc: selects an item class constructor based on the item type passed as an argument and returns that as a class instantiation 'function' object to call the correct class in methods that eg select by item type or return items. In essence it acts as a sort of clearing house to try to ensure that any recognised but unwrapped items are wrapped with the correct modo.item.xxx type before being returned. example usage:: # get a list of all the light items in a scene where each light in the list is returned as the correctly # wrapped modo version of each light sub-type. import modo scene = modo.Scene() lights = [] for light in scene.ItemList(modo.c.LIGHT_TYPE): func = modo.c.typeToFunc(light.Type()) lights.append(func(light)) # or more succinctly as a list comprehension: lights = [modo.c.typeToFunc(light.Type())(light) for light in scene.ItemList(modo.c.LIGHT_TYPE)]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.ChannelTriple

type: type

doc: Wrapper to allow setting and reading all three channels on a vector 'channel' at once :param basestring channelName: The channel name. eg 'diffCol' :param modo.item.Item item: The item the channel belongs to. :raises: LookUpError if no respective channel of the given name was found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.ChannelTriple.get(self)

type: instancemethod

doc: Same arguments as Channel.get()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.ChannelTriple.set(self,values,time,action)

type: instancemethod

doc: Sets three values for the three channels at once :param float time: Time in seconds for the value to be set at (optional) :param basestring action: Action to set the value for (optional)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.constants

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.current

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.CylinderLight

type: type

doc: Cylinder light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Cylinder Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Cylinder Light item. :param light: Optional Cylinder light item object (type lx.symbol.sITYPE_CYLINDERLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid cylinder light item selected. :raises TypeError: if the item passed as an argument isn't either a cylinder light or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight._item

type: property

modo.CylinderLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.CylinderLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.CylinderLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.CylinderLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.CylinderLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.CylinderLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.CylinderLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.CylinderLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.CylinderLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.CylinderLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.CylinderLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.CylinderLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.CylinderLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.CylinderLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.CylinderLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.CylinderLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.CylinderLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.CylinderLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.CylinderLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.CylinderLight.scene

type: property

modo.CylinderLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.CylinderLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.CylinderLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.CylinderLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.CylinderLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Deformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer._item

type: property

modo.Deformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.Deformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.Deformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.Deformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.Deformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.Deformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.Deformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.Deformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.Deformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.Deformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.Deformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.Deformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.Deformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.Deformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.Deformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.Deformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.Deformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.scene

type: property

modo.Deformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.Deformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Deformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Deformer.svc

type: Deformer

modo.Deformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.DeformerGroup

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup._item

type: property

modo.DeformerGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.DeformerGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.DeformerGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.DeformerGroup.connectInput(self,other)

type: instancemethod

doc: Connects an influence deformer into this deformGroup :param other:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.createJointLocator(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.DeformerGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.DeformerGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.DeformerGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.DeformerGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.DeformerGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.DeformerGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.DeformerGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.mesh(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.DeformerGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.DeformerGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.DeformerGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.DeformerGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.scene

type: property

modo.DeformerGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.DeformerGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DeformerGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.DeformerGroup.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.dialogs

type: module

doc: .. module:: modo.dialogs :synopsis: Functions to display the various modo dialog types. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.alert

type: function

doc: A simple alert dialog. Type can be any one of 'info', 'warning' or 'error' depending on the value passed for 'dtype', defaults to 'info' :param title: Dialog title. :type title: string :param dtype: Dialog type. One of 'info', 'warning', 'error'. Defaults to 'info' :type dtype: string :param message: Dialog message. :type message: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.cmd

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.cmdSvc

type: Command

modo.dialogs.customFile

type: function

doc: Displays a file open or file save dialog for one or more custom file types. :returns: A single file path for "fileSave' and 'fileOpen' dialogs, a list of file paths for 'fileOpenMulti' dialogs or 'None' if dialog is cancelled by the user. :rtype: string or None :param dtype: Dialog type, string, one of 'fileOpen', 'fileOpenMulti' or 'fileSave'. :type dtype: string. :param title: Dialog title. :type title: string. :param names: List or tuple of file format type names. This is an internal name for use by the script, and can be read out after the dialog is dismissed by querying dialog.fileSaveFormat. :type names: list or tuple of strings. :param unames: List of user names that will be displayed in the dialog for each of the types specified in ftype. :type unames: list or tuple of strings. :param patterns: Optional collection of semicolon-delimited string lists of file extensions that the particular file format supports. Only used for fileOpen dialogs. Each extension must include a leading asterisk and period for the filtering to work properly, such as '*.jpg;*.jpeg'. :type patterns: list or tuple of strings. :param ext: Optional collection of save extensions, one for each of the types specified in ftype. each ext is a single file extension that will automatically be appended to the end of the filename selected in a save dialog. The period should not be entered, just the extension such as lwo, tga or txt. :type ext: list or tuple of strings. :param path: Optional default path to open the dialog at. :type path: string. File open examples:: # Single file format inpath = modo.dialogs.customFile('fileOpen', 'Open File', ('text',), ('Text File',), ('*.txt',)) # Multiple file formats inpath = modo.dialogs.customFile('fileOpen', 'Open File', ('text', 'html',), ('Text File', 'HTML FIle'), ('*.txt', '*.html',)) # open multiple files inpaths = modo.dialogs.customFile('fileOpenMulti', 'Open File', ('text',), ('Text File',), ('*.txt',)) File save examples:: # Single file format outpath = modo.dialogs.customFile('fileSave', 'Save File', ('text',), ('Text File',), ext=('txt',)) #Multiple file formats outpath = modo.dialogs.customFile('fileSave', 'Save File', ('text', 'html',), ('Text File', 'HTML FIle'), ext=('txt', 'html',))

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.dialogSvc

type: StdDialog

modo.dialogs.dirBrowse

type: function

doc: Display a directory dialog. :returns: file path or 'None' if dialog is cancelled by the user. :rtype: string or None :param title: Dialog title string. :type title: string :param path: Optional default path to open the dialog at. :type path: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.fileOpen

type: function

doc: Display a dialog to choose a file or files for opening. :returns: Single file path if 'multi' is False, list of files paths if 'multi' is true or 'None' if the dialog is cancelled by the user. :rtype: string or None :param ftype: File format type to filter on or None to show all files. :type ftype: string :param title: Dialog title. :type title: str :param multi: Enable multi-select of files in the dialog. :type multi: Boolean :param path: Optional path to open the dialog at. :type path: str Open dialogs use a file type to filter the load dialog. A file type is the class of data to be loaded or saved, such as an image or an object and should be one of the known file types, such as text, script, config, macro, image, and so on. Also, the name of any specific loader plug-in can also be used, such as $LWO. If no file type is set, all files will be shown.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.fileSave

type: function

doc: Display a dialog to choose a filename to save to. :returns: file path or 'None' if dialog is cancelled by the user. :rtype: string or None :param ftype: File type to save as. :type ftype: string :param fformat: Default file format to save as :type fformat: string :param fspec: How the file format is specified, either by 'extension' for file extension or 'format' for file format name. Defaults to 'extension'. :type fspec: string :param title: Dialog title. :type title: string :param path: Optional default path to open the dialog at. :type path: string A save dialog is identical to an open dialog, but adds a save format to select a specific default file format within the file type to save as. This format will be selected by default when the dialog opens The file format can be set either by its default extension, which is the default behavior, or by the file format's internal name.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.globalInterpreter

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.dialogs.okCancel

type: function

doc: A two button OK/Cancel message dialog. :returns: 'ok' or 'cancel' :rtype: string :param title: Dialog title. :type title: string :param message: Dialog message. :type message: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.saveOK

type: function

doc: A Save OK dialog. :returns: 'save', or 'cancel' :rtype: string :param title: Dialog title. :type title: string :param message: Dialog message. :type message: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.yesAllCancel

type: function

doc: A three button Yes/Yes to all/Cancel dialog. :returns: 'yes', 'yesall' or 'cancel' :rtype: string :param title: Dialog title. :type title: string :param message: Dialog message. :type message: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.yesNo

type: function

doc: A two button Yes/No message dialog. :returns: 'yes' or 'no' :rtype: string :param title: Dialog title. :type title: string :param message: Dialog message. :type message: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.yesNoAll

type: function

doc: A four option Yes/Yes to all/No/No to all dialog. :returns: 'yes', 'yestoall', 'no', 'notoall' or 'cancel' :rtype: string :param title: Dialog title. :type title: string :param message: Dialog message. :type message: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.yesNoCancel

type: function

doc: A three button Yes/No/Cancel message dialog. :returns: 'yes', or 'cancel' :rtype: string :param title: Dialog title. :type title: string :param message: Dialog message. :type message: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.dialogs.yesnoToAll

type: function

doc: A three option Yes/No/No to all dialog. :returns: 'yes', 'noall' or 'cancel' :rtype: string :param title: Dialog title. :type title: string :param message: Dialog message. :type message: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\dialogs.py

modo.DirectionalLight

type: type

doc: Directional light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Directional Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Directional Light item. :param light: Optional Directional light item object (type lx.symbol.sITYPE_SUNLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid directional light item selected. :raises TypeError: if the item passed as an argument isn't either a Directional light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight._item

type: property

modo.DirectionalLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.DirectionalLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.DirectionalLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.DirectionalLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.DirectionalLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.DirectionalLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.DirectionalLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.DirectionalLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.DirectionalLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.DirectionalLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.DirectionalLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.DirectionalLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.DirectionalLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.DirectionalLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.DirectionalLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.DirectionalLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.DirectionalLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.DirectionalLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.DirectionalLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.DirectionalLight.scene

type: property

modo.DirectionalLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.DirectionalLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DirectionalLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.DirectionalLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.DirectionalLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.DomeLight

type: type

doc: Dome light item class Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Dome Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Dome Light item. :param light: Optional Dome light item object (type lx.symbol.sITYPE_DOMELIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Dome light item selected. :raises TypeError: if the item passed as an argument isn't either a Dome light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight._item

type: property

modo.DomeLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.DomeLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.DomeLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.DomeLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.DomeLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.DomeLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.DomeLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.DomeLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.DomeLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.DomeLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.DomeLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.DomeLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.DomeLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.DomeLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.DomeLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.DomeLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.DomeLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.DomeLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.DomeLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.DomeLight.scene

type: property

modo.DomeLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.DomeLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.DomeLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.DomeLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.DomeLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Envelope

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Envelope.behavior

type: property

doc: gets/sets the behavior of times for both before the first keyframe and after the last keyframe in the envelope. :setter: Sets the envelope behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope behavior :rtype: int

modo.Envelope.clear(self)

type: instancemethod

doc: Clears (removes all keys from) the envelope.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Envelope.interpolation

type: property

doc: Returns the interpolation setting for the envelope. Can be one of: | lx.symbol.iENVv_INTERP_CURVE | lx.symbol.iENVv_INTERP_LINEAR | lx.symbol.iENVv_INTERP_STEPPED :getter: Returns the interpolation setting for the envelope. :rtype: int

modo.Envelope.isInt

type: property

doc: Returns whether the envelope is integer-valued type, if not it's a float type. :Getter: Returns True if the envelope is integer-valued type, False otherwise. :rtype: bool

modo.Envelope.keyframes

type: property

doc: Returns a :class:`Keyframes` object that provides access to the keyframes set for the envelope and methods to manipulate them. :getter: Returns a :class:`Keyframes` object containing the keys for this envelope. :rtype: modo.channel.Keyframes

modo.Envelope.postBehaviour

type: property

doc: gets/sets the behavior of times after the last keyframe in the envelope. :setter: Sets the envelope post behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope post behavior :rtype: int

modo.Envelope.preBehaviour

type: property

doc: gets/sets the behavior of times before the first keyframe in the envelope. - **RESET** A default value, or may be just zero. - **CONSTANT** The value of the first or last keyframe. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **REPEAT** The values in the keyframe range repeating continuously. - **OSCILLATE** Like repeat, but the values run forwards and backward alternately. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **OFFSETREPEAT** Like repeat, but the values are offset in each cycle by the difference between the first and last keyframes. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **LINEAR** Linear interpolation from the slope at the nearest keyframe. - **NONE** Indicates that the envelope does not exist before or after the explicit keyframe range. This can be used by motion evaluation code to decide whether to use the envelope for a channel or to look up the parent envelope or default value. - **CONSTANT_KEEP_SLOPE** As for constant except that the slopes of the first or last keys are not changed. - **OSCILLATE_KEEP_SLOPE** As for oscillate except that the slopes of the first or last keys are not changed. - **OFFSETREPEAT_KEEP_SLOPE** As for offset repeat except that the slopes of the first or last keys are not changed. :setter: Sets the behavior :param behavior: the behaviour to set for the envelope. Can be one of: | lx.symbol.iENV_RESET | lx.symbol.iENV_CONSTANT | lx.symbol.iENV_REPEAT | lx.symbol.iENV_OSCILLATE | lx.symbol.iENV_OFFSETREPEAT | lx.symbol.iENV_LINEAR | lx.symbol.iENV_NONE | lx.symbol.iENV_CONSTANT_KEEP_SLOPE | lx.symbol.iENV_OSCILLATE_KEEP_SLOPE | lx.symbol.iENV_OFFSETREPEAT_KEEP_SLOPE :type behavior: int :getter: Returns envelope behavior :rtype: int

modo.Envelope.value(self,time)

type: instancemethod

doc: Returns the value of the envelope evaluated at the specified time. If no time is explicitly provided the value of the envelope at the current time is returned :param time: time to evaluate envelope at. :type time: float :returns: value of the envelope :rtype: float for float type envelopes, int for integer-valued type envelopes

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.GeneralInfluenceDeformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer._item

type: property

modo.GeneralInfluenceDeformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.GeneralInfluenceDeformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.GeneralInfluenceDeformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.GeneralInfluenceDeformer.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.GeneralInfluenceDeformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.GeneralInfluenceDeformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.GeneralInfluenceDeformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.GeneralInfluenceDeformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.GeneralInfluenceDeformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.GeneralInfluenceDeformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.GeneralInfluenceDeformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.mapName

type: property

doc: :getter: Returns the UI version of the map name as string

modo.GeneralInfluenceDeformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.GeneralInfluenceDeformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.GeneralInfluenceDeformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.GeneralInfluenceDeformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.GeneralInfluenceDeformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.GeneralInfluenceDeformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.GeneralInfluenceDeformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.scene

type: property

modo.GeneralInfluenceDeformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.GeneralInfluenceDeformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GeneralInfluenceDeformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.GeneralInfluenceDeformer.svc

type: Deformer

modo.GeneralInfluenceDeformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Group

type: type

doc: A group item. Takes an optional 'groupItem' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group' or an item name or ID to look up. If no groupItem is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. 'gtype' can be any one of the built in group types by passing one of the built in type strings ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader'), an empty string for a general group or any other string to create a custom group type. :param groupItem: an optional group item (type lx.symbol.sITYPE_GROUP) or an item name/ID to look up. :type groupItem: an instance of lx.object.Item, lxu.object.item or modo.item.Item :param gtype: the group type. :type gtype: basestring :raises TypeError: if an item is supplied as the groupItem argument but is not of type lx.symbol.sITYPE_GROUP. :raises ValueError: if no groupItem argument is supplied and no valid group item is selected in the scene. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found. Note that the children() method derived from the Item object will only list child groups. To iterate the contained items, use the method items.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group._item

type: property

modo.Group._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.Group.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.Group.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.Group.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.Group.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.Group.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.Group.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.Group.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.Group.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.Group.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.Group.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.Group.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.Group.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.Group.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.Group.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.Group.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.Group.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.Group.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.Group.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.scene

type: property

modo.Group.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.Group.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Group.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Group.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.GroupLocator

type: type

doc: Group locator item class. Takes an optional 'grploc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group locator' or an item name or ID to look up. If no grploc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param grploc: Optional group locator item object (type lx.symbol.sITYPE_GROUPLOCATOR) or string (item name or ID) to look up. :type grploc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid group locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'group locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the grploc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator._item

type: property

modo.GroupLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.GroupLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.GroupLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.GroupLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.GroupLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.GroupLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.GroupLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.GroupLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.GroupLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.GroupLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.GroupLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.GroupLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.GroupLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.GroupLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.GroupLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.GroupLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.GroupLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.GroupLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.GroupLocator.scene

type: property

modo.GroupLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.GroupLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.GroupLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.GroupLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.GroupLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Item

type: type

doc: Base item class Takes an optional lx.object.Item object as an argument. If none is provided (the default) then the most recently selected item is used. :param item: Optional item object to wrap. :type item: an instance of lx.object.Item or lxu.object.item :raises ValueError: if no item is passed as an argument and no valid items are currently selected. :raises LookupError: if a string (item name or ID) is passed as the item argument and no item with that name or ID cane be found in the scene. :raises TypeError: if the object passed as the 'item' argument isn't an instance of lx.object.Item.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item._item

type: property

modo.Item._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.Item.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.Item.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.Item.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.Item.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.Item.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.Item.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.Item.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.Item.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.Item.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.Item.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.Item.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.Item.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.Item.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.Item.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.scene

type: property

modo.Item.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.Item.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Item.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Item.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip

type: type

doc: Action Clip and Render pass item. :param item: either an item of type 'actionclip' or an item name/ID to lookup. :type item: an instance of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip._item

type: property

modo.item.ActionClip._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.active

type: property

doc: Set or get the active state of the render pass. :getter: Returns the active state of the render pass. :rtype: bool :setter: Sets the active state of the renter pass :param state: active state. :type state: bool

modo.item.ActionClip.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.ActionClip.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.ActionClip.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.ActionClip.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.ActionClip.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.enabled

type: property

doc: Get or set the enabled state of the render pass. :getter: Returns the enabled state. :rtype: bool :setter: Sets the enabled state of the render pass :param state: enabled state. :type state: bool

modo.item.ActionClip.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.getValue(self,chan,time)

type: instancemethod

doc: Read a value set on a channel for this render pass. :param chan: the channel to read the value from. :type chan: modo.channel.Channel object :param time: the time (in seconds) to read the value for, defaults to 0.0. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.ActionClip.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.ActionClip.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.ActionClip.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.ActionClip.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.ActionClip.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.ActionClip.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.name

type: property

doc: Name of the render pass. :getter: Returns the name of the render pass :rtype: basestring :setter: Assigns a new name to the render pass :param name: new name for the render pass. :type name: basestring

modo.item.ActionClip.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.ActionClip.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.ActionClip.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.ActionClip.passGroup

type: property

doc: The render pass group that the render pass belongs to. :getter: Returns the render pass group :rtype: modo.item.RenderPassGroup :setter: Sets the render pass group :param group: render pass group to parent to. :type group: modo.item.RenderPassGroup

modo.item.ActionClip.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.scene

type: property

modo.item.ActionClip.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.ActionClip.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.setValue(self,chan,value,time,key)

type: instancemethod

doc: Set a value on a channel for this render pass. :param chan: the channel to set the value on. :type chan: modo.channel.Channel object :param value: the value to set for the channel. :type value: any :param time: the time (in seconds) to set the value for, defaults to 0.0. :type time: float :param key: whether to set a key for the value or not, defaults to False. :param key: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ActionClip.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.ActionClip.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Actor

type: type

doc: Wrapper class for actor groups.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor._Actor__addClip(self,name,pose)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor._item

type: property

modo.item.Actor._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.actions

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.item.Actor.addAction(self,name)

type: instancemethod

doc: Adds an action to this actor Note: please avoid naming actions 'setup', 'edit' or 'scene' :returns ActionClip: ActionClip :param basestring name: Optional name for the action

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.addPose(self,name,activate)

type: instancemethod

doc: Adds a pose to this actor :returns ActionClip: ActionClip :param basestring name: Optional name for the pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.Actor.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.Actor.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.Actor.currentAction

type: property

doc: :getter: Returns the currently active action if any. None if no action is active :rtype: ActionClip

modo.item.Actor.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.Actor.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.item.Actor.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.item.Actor.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.Actor.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.Actor.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.Actor.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.Actor.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.item.Actor.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.Actor.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.Actor.items

type: property

doc: :getter: Returns a list of LocatorSuperType items that are connected to this action. :rtype: list

modo.item.Actor.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.Actor.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.Actor.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.Actor.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.Actor.pose(self,poseName)

type: instancemethod

doc: Return a pose by name :param basestring poseName: Name of the pose to look up :returns: Pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.poses

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.item.Actor.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.scene

type: property

modo.item.Actor.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.Actor.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Actor.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Actor.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.item.AreaLight

type: type

doc: Area light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Area Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. :param light: Optional area light item object (type lx.symbol.sITYPE_AREALIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid area light item selected. :raises TypeError: if the item passed as an argument isn't either an area light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight._item

type: property

modo.item.AreaLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.AreaLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.AreaLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.AreaLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.AreaLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.AreaLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.AreaLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.AreaLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.AreaLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.AreaLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.AreaLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.item.AreaLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.AreaLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.AreaLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.AreaLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.AreaLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.AreaLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.AreaLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.AreaLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.AreaLight.scene

type: property

modo.item.AreaLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.AreaLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.AreaLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.AreaLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.AreaLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.item.Camera

type: type

doc: Camera item class. Takes an optional 'camera' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'camera' or an item name or ID to look up. If no camera item is supplied as an argument an attempt will be made to wrap the most recently selected camera. :param camera: Optional camera item object (type lx.symbol.sITYPE_CAMERA) or string (item name or ID) to look up. :type camera: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid camera item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'camera' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the camera argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera._item

type: property

modo.item.Camera._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.Camera.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.Camera.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.Camera.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.Camera.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.Camera.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.Camera.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.Camera.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.Camera.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.Camera.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.Camera.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.Camera.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.Camera.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.Camera.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.Camera.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Camera.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Camera.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Camera.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Camera.scene

type: property

modo.item.Camera.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.Camera.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Camera.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Camera.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.Camera.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Channel

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Add a link between this channel and another. :param to_channel: The channel to link to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Channel.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Delete a link from the channel graph. :param to_channel: The channel the link is to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Channel.disconnectInput(self,other)

type: instancemethod

doc: Removes an input connection from another channel if it exists. :param Channel other: Other channel to disconnect from. If it is None, all input connections are removed.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Channel.envelope

type: property

doc: Returns the channel's animation envelope. :getter: Returns the channel's animation envelope. :rtype: modo.channel.Envelope :raises LookupError: if the channel isn't animated.

modo.item.Channel.evalType

type: property

doc: Returns the evaluation type of a channel, which is the type of slot allocated in the eval state vector. This will return the "gradstack" exo-type for gradient channels. :getter: Returns the evaluation type of the channel :rtype: basestring

modo.item.Channel.forward(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index forward of this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index forward of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Channel.fwdCount

type: property

doc: Returns the number of linked channels forward of this channel in this channel graph. :getter: Returns the number of linked channels forward of this channel in this channel graph. :rtype: int

modo.item.Channel.fwdLinked

type: property

doc: Returns a list of the linked channels forward of this channel in the channel graph. :getter: Returns the forward channels in this item's channel graph. :rtype: list

modo.item.Channel.get(self,time,action)

type: instancemethod

doc: Returns a channel's value for an action at a specific time. Defaults to reading the channel's evaluated value at the current time. :param time: Optional time in seconds to read the value at. :type time: float :param action: The action to read the value from. Defaults to None (evaluation). :type action: basestring :returns: the channel's value. :rtype: depends on the type of the channel being read.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Channel.graph

type: property

doc: The channel's channel graph. :getter: Returns the channel's channel graph. :rtype: lxu.object.ChannelGraph

modo.item.Channel.index

type: property

doc: The channel's index. :getter: Returns the channel's index. :rtype: int

modo.item.Channel.isAnimated

type: property

doc: Returns whether the channel is animated. :getter: Returns whether the channel is animated or not. :rtype: bool

modo.item.Channel.item

type: property

doc: :getter: Returns the item that is associated with this channel :rtype: Item

modo.item.Channel.name

type: property

doc: The channel's name. :getter: Returns the channel's name. :rtype: basestring

modo.item.Channel.revCount

type: property

doc: Returns the number of linked channels that occur before this channel in the channel graph. :getter: Returns the number of linked channels that occur before this channel in the channel graph. :rtype: int

modo.item.Channel.reverse(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index before this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index before of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Channel.revLinked

type: property

doc: Returns a list of the linked channels that appear before this channel in the channel graph. :getter: Returns the linked channels that appear before this channel in the channel graph. :rtype: list

modo.item.Channel.set(self,value,time,key,action)

type: instancemethod

doc: Sets a channel's value for an action at a specific time. Defaults to setting the channel's value for the "edit" action and at the current time. :param value: The value to set for the channel. :type value: depends on the type of the channel :param time: optional time in seconds to set the value for. :type time: float :param key: Specifies whether to set a key for the channel. :type key: bool :param action: The action to set the value on. :type action: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Set a link's position (from index, to index) in the channel graph. :param from_index: The index in the channel graph for the current (from) channel. :type from_index: int :param to_channel: The to channel. :type to_channel: modo.channel.Channel :param to_index: the index in the channel graph for the 'to' channel. :type to_index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Channel.storageType

type: property

doc: Returns the storage type of the channel, which can be valid exo-type name for numeric and stored custom types or None if no storage type is found. :getter: Returns the channel storage type :rtype: basestring

modo.item.Channel.type

type: property

doc: Returns the channel type. The numeric and gradient types can be keyframed. The return type is an int which translates to the following types: | 0: none | 1: integer | 2: float | 3: gradient | 4: storage | 5: eval :getter: Returns the channel type. :rtype: int

modo.item.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.item.ChannelRead contents:
  • modo.item.ChannelRead.__class__
  • modo.item.ChannelRead.__delattr__
  • modo.item.ChannelRead.__dict__
  • modo.item.ChannelRead.__doc__
  • modo.item.ChannelRead.__format__
  • modo.item.ChannelRead.__getattr__
  • modo.item.ChannelRead.__getattribute__
  • modo.item.ChannelRead.__hash__
  • modo.item.ChannelRead.__init__
  • modo.item.ChannelRead.__module__
  • modo.item.ChannelRead.__new__
  • modo.item.ChannelRead.__reduce__
  • modo.item.ChannelRead.__reduce_ex__
  • modo.item.ChannelRead.__repr__
  • modo.item.ChannelRead.__setattr__
  • modo.item.ChannelRead.__sizeof__
  • modo.item.ChannelRead.__str__
  • modo.item.ChannelRead.__subclasshook__
  • modo.item.ChannelRead.__weakref__
  • modo.item.ChannelRead.set

modo.item.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.ChannelTriple

type: type

doc: Wrapper to allow setting and reading all three channels on a vector 'channel' at once :param basestring channelName: The channel name. eg 'diffCol' :param modo.item.Item item: The item the channel belongs to. :raises: LookUpError if no respective channel of the given name was found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.item.ChannelTriple contents:
  • modo.item.ChannelTriple.__class__
  • modo.item.ChannelTriple.__delattr__
  • modo.item.ChannelTriple.__dict__
  • modo.item.ChannelTriple.__doc__
  • modo.item.ChannelTriple.__format__
  • modo.item.ChannelTriple.__getattribute__
  • modo.item.ChannelTriple.__hash__
  • modo.item.ChannelTriple.__init__
  • modo.item.ChannelTriple.__module__
  • modo.item.ChannelTriple.__new__
  • modo.item.ChannelTriple.__reduce__
  • modo.item.ChannelTriple.__reduce_ex__
  • modo.item.ChannelTriple.__repr__
  • modo.item.ChannelTriple.__setattr__
  • modo.item.ChannelTriple.__sizeof__
  • modo.item.ChannelTriple.__str__
  • modo.item.ChannelTriple.__subclasshook__
  • modo.item.ChannelTriple.__weakref__
  • modo.item.ChannelTriple.get
  • modo.item.ChannelTriple.set

modo.item.ChannelTriple.get(self)

type: instancemethod

doc: Same arguments as Channel.get()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.ChannelTriple.set(self,values,time,action)

type: instancemethod

doc: Sets three values for the three channels at once :param float time: Time in seconds for the value to be set at (optional) :param basestring action: Action to set the value for (optional)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.item.ChannelWrite contents:
  • modo.item.ChannelWrite.__class__
  • modo.item.ChannelWrite.__delattr__
  • modo.item.ChannelWrite.__dict__
  • modo.item.ChannelWrite.__doc__
  • modo.item.ChannelWrite.__format__
  • modo.item.ChannelWrite.__getattr__
  • modo.item.ChannelWrite.__getattribute__
  • modo.item.ChannelWrite.__hash__
  • modo.item.ChannelWrite.__init__
  • modo.item.ChannelWrite.__module__
  • modo.item.ChannelWrite.__new__
  • modo.item.ChannelWrite.__reduce__
  • modo.item.ChannelWrite.__reduce_ex__
  • modo.item.ChannelWrite.__repr__
  • modo.item.ChannelWrite.__setattr__
  • modo.item.ChannelWrite.__sizeof__
  • modo.item.ChannelWrite.__str__
  • modo.item.ChannelWrite.__subclasshook__
  • modo.item.ChannelWrite.__weakref__
  • modo.item.ChannelWrite.set

modo.item.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.CylinderLight

type: type

doc: Cylinder light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Cylinder Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Cylinder Light item. :param light: Optional Cylinder light item object (type lx.symbol.sITYPE_CYLINDERLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid cylinder light item selected. :raises TypeError: if the item passed as an argument isn't either a cylinder light or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight._item

type: property

modo.item.CylinderLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.CylinderLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.CylinderLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.CylinderLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.CylinderLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.CylinderLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.CylinderLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.CylinderLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.CylinderLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.CylinderLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.CylinderLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.item.CylinderLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.CylinderLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.CylinderLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.CylinderLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.CylinderLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.CylinderLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.CylinderLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.CylinderLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.CylinderLight.scene

type: property

modo.item.CylinderLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.CylinderLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.CylinderLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.CylinderLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.CylinderLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Deformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer._item

type: property

modo.item.Deformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.Deformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.Deformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.Deformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.Deformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.Deformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.Deformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.Deformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.Deformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.Deformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.Deformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.item.Deformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.Deformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.item.Deformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.Deformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.Deformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.Deformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.scene

type: property

modo.item.Deformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.Deformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Deformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Deformer.svc

type: Deformer

modo.item.Deformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.DeformerGroup

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup._item

type: property

modo.item.DeformerGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.DeformerGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.DeformerGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.DeformerGroup.connectInput(self,other)

type: instancemethod

doc: Connects an influence deformer into this deformGroup :param other:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.createJointLocator(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.DeformerGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.DeformerGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.DeformerGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.DeformerGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.DeformerGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.DeformerGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.DeformerGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.mesh(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.DeformerGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.DeformerGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.DeformerGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.DeformerGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.scene

type: property

modo.item.DeformerGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.DeformerGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DeformerGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.DeformerGroup.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.DirectionalLight

type: type

doc: Directional light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Directional Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Directional Light item. :param light: Optional Directional light item object (type lx.symbol.sITYPE_SUNLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid directional light item selected. :raises TypeError: if the item passed as an argument isn't either a Directional light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight._item

type: property

modo.item.DirectionalLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.DirectionalLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.DirectionalLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.DirectionalLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.DirectionalLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.DirectionalLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.DirectionalLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.DirectionalLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.DirectionalLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.DirectionalLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.DirectionalLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.item.DirectionalLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.DirectionalLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.DirectionalLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.DirectionalLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.DirectionalLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.DirectionalLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.DirectionalLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.DirectionalLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.DirectionalLight.scene

type: property

modo.item.DirectionalLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.DirectionalLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DirectionalLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.DirectionalLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.DirectionalLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.DomeLight

type: type

doc: Dome light item class Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Dome Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Dome Light item. :param light: Optional Dome light item object (type lx.symbol.sITYPE_DOMELIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Dome light item selected. :raises TypeError: if the item passed as an argument isn't either a Dome light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight._item

type: property

modo.item.DomeLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.DomeLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.DomeLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.DomeLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.DomeLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.DomeLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.DomeLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.DomeLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.DomeLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.DomeLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.DomeLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.item.DomeLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.DomeLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.DomeLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.DomeLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.DomeLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.DomeLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.DomeLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.DomeLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.DomeLight.scene

type: property

modo.item.DomeLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.DomeLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.DomeLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.DomeLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.DomeLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Envelope

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Envelope.behavior

type: property

doc: gets/sets the behavior of times for both before the first keyframe and after the last keyframe in the envelope. :setter: Sets the envelope behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope behavior :rtype: int

modo.item.Envelope.clear(self)

type: instancemethod

doc: Clears (removes all keys from) the envelope.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Envelope.interpolation

type: property

doc: Returns the interpolation setting for the envelope. Can be one of: | lx.symbol.iENVv_INTERP_CURVE | lx.symbol.iENVv_INTERP_LINEAR | lx.symbol.iENVv_INTERP_STEPPED :getter: Returns the interpolation setting for the envelope. :rtype: int

modo.item.Envelope.isInt

type: property

doc: Returns whether the envelope is integer-valued type, if not it's a float type. :Getter: Returns True if the envelope is integer-valued type, False otherwise. :rtype: bool

modo.item.Envelope.keyframes

type: property

doc: Returns a :class:`Keyframes` object that provides access to the keyframes set for the envelope and methods to manipulate them. :getter: Returns a :class:`Keyframes` object containing the keys for this envelope. :rtype: modo.channel.Keyframes

modo.item.Envelope.postBehaviour

type: property

doc: gets/sets the behavior of times after the last keyframe in the envelope. :setter: Sets the envelope post behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope post behavior :rtype: int

modo.item.Envelope.preBehaviour

type: property

doc: gets/sets the behavior of times before the first keyframe in the envelope. - **RESET** A default value, or may be just zero. - **CONSTANT** The value of the first or last keyframe. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **REPEAT** The values in the keyframe range repeating continuously. - **OSCILLATE** Like repeat, but the values run forwards and backward alternately. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **OFFSETREPEAT** Like repeat, but the values are offset in each cycle by the difference between the first and last keyframes. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **LINEAR** Linear interpolation from the slope at the nearest keyframe. - **NONE** Indicates that the envelope does not exist before or after the explicit keyframe range. This can be used by motion evaluation code to decide whether to use the envelope for a channel or to look up the parent envelope or default value. - **CONSTANT_KEEP_SLOPE** As for constant except that the slopes of the first or last keys are not changed. - **OSCILLATE_KEEP_SLOPE** As for oscillate except that the slopes of the first or last keys are not changed. - **OFFSETREPEAT_KEEP_SLOPE** As for offset repeat except that the slopes of the first or last keys are not changed. :setter: Sets the behavior :param behavior: the behaviour to set for the envelope. Can be one of: | lx.symbol.iENV_RESET | lx.symbol.iENV_CONSTANT | lx.symbol.iENV_REPEAT | lx.symbol.iENV_OSCILLATE | lx.symbol.iENV_OFFSETREPEAT | lx.symbol.iENV_LINEAR | lx.symbol.iENV_NONE | lx.symbol.iENV_CONSTANT_KEEP_SLOPE | lx.symbol.iENV_OSCILLATE_KEEP_SLOPE | lx.symbol.iENV_OFFSETREPEAT_KEEP_SLOPE :type behavior: int :getter: Returns envelope behavior :rtype: int

modo.item.Envelope.value(self,time)

type: instancemethod

doc: Returns the value of the envelope evaluated at the specified time. If no time is explicitly provided the value of the envelope at the current time is returned :param time: time to evaluate envelope at. :type time: float :returns: value of the envelope :rtype: float for float type envelopes, int for integer-valued type envelopes

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.item.GeneralInfluenceDeformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer._item

type: property

modo.item.GeneralInfluenceDeformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.GeneralInfluenceDeformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.GeneralInfluenceDeformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.GeneralInfluenceDeformer.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.GeneralInfluenceDeformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.GeneralInfluenceDeformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.GeneralInfluenceDeformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.GeneralInfluenceDeformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.GeneralInfluenceDeformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.GeneralInfluenceDeformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.GeneralInfluenceDeformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.mapName

type: property

doc: :getter: Returns the UI version of the map name as string

modo.item.GeneralInfluenceDeformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.item.GeneralInfluenceDeformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.GeneralInfluenceDeformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.item.GeneralInfluenceDeformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.GeneralInfluenceDeformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.GeneralInfluenceDeformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.GeneralInfluenceDeformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.scene

type: property

modo.item.GeneralInfluenceDeformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.GeneralInfluenceDeformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GeneralInfluenceDeformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.GeneralInfluenceDeformer.svc

type: Deformer

modo.item.GeneralInfluenceDeformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Group

type: type

doc: A group item. Takes an optional 'groupItem' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group' or an item name or ID to look up. If no groupItem is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. 'gtype' can be any one of the built in group types by passing one of the built in type strings ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader'), an empty string for a general group or any other string to create a custom group type. :param groupItem: an optional group item (type lx.symbol.sITYPE_GROUP) or an item name/ID to look up. :type groupItem: an instance of lx.object.Item, lxu.object.item or modo.item.Item :param gtype: the group type. :type gtype: basestring :raises TypeError: if an item is supplied as the groupItem argument but is not of type lx.symbol.sITYPE_GROUP. :raises ValueError: if no groupItem argument is supplied and no valid group item is selected in the scene. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found. Note that the children() method derived from the Item object will only list child groups. To iterate the contained items, use the method items.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group._item

type: property

modo.item.Group._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.Group.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.Group.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.Group.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.Group.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.item.Group.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.item.Group.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.Group.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.Group.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.Group.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.Group.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.item.Group.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.Group.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.Group.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.item.Group.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.Group.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.Group.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.Group.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.Group.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.scene

type: property

modo.item.Group.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.Group.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Group.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Group.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.item.GroupLocator

type: type

doc: Group locator item class. Takes an optional 'grploc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group locator' or an item name or ID to look up. If no grploc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param grploc: Optional group locator item object (type lx.symbol.sITYPE_GROUPLOCATOR) or string (item name or ID) to look up. :type grploc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid group locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'group locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the grploc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator._item

type: property

modo.item.GroupLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.GroupLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.GroupLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.GroupLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.GroupLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.GroupLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.GroupLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.GroupLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.GroupLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.GroupLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.GroupLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.GroupLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.GroupLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.GroupLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.GroupLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.GroupLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.GroupLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.GroupLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.GroupLocator.scene

type: property

modo.item.GroupLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.GroupLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.GroupLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.GroupLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.GroupLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Item

type: type

doc: Base item class Takes an optional lx.object.Item object as an argument. If none is provided (the default) then the most recently selected item is used. :param item: Optional item object to wrap. :type item: an instance of lx.object.Item or lxu.object.item :raises ValueError: if no item is passed as an argument and no valid items are currently selected. :raises LookupError: if a string (item name or ID) is passed as the item argument and no item with that name or ID cane be found in the scene. :raises TypeError: if the object passed as the 'item' argument isn't an instance of lx.object.Item.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item._item

type: property

modo.item.Item._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.Item.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.Item.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.Item.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.Item.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.Item.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.Item.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.Item.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.Item.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.Item.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.Item.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.Item.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.Item.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.Item.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.Item.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.scene

type: property

modo.item.Item.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.Item.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Item.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Item.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.ItemGraph

type: type

doc: Utility container class for quick access to ItemGraph compatible graphs :param item: Item to look up graph for :param ls.symbol.sGRAPH_* graphType: Graph to look up. Common ones are 'parent', 'deformers', 'groups', 'chanMods' :param bool reverse: Indices traverse the graph forwards if false or reverse if true

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ItemGraph._ItemGraph__toType

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ItemGraph.connectedItems

type: property

doc: :getter: Returns a dictionary that lists the input- and output items at once. :rtype: dictionary

modo.item.ItemGraph.connectInput(self,other)

type: instancemethod

doc: Connects the given item as input. This function is called by the >> operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ItemGraph.disconnectInput(self,other)

type: instancemethod

doc: Removes the given item from the input connections if any. This function is called by the << operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ItemGraph.forward(self,index)

type: instancemethod

doc: :returns list: Items of the forward connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ItemGraph.item

type: property

doc: :getter: Returns the Item that this ItemGraph instance is bound to. :return type: Item

modo.item.ItemGraph.reverse(self,index)

type: instancemethod

doc: :returns list: Items of the reverse connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ItemGraph.setReverse(self,reverse)

type: instancemethod

doc: Sets the direction that is used for lookup when using the angular brackets [] :param bool reverse: If True the graph is looked up forwards, if False, backwards.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.ItemGraph.type

type: property

doc: :getter: Returns the name of the graph type that this instance represents. :return type: basestring

modo.item.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.Joint

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint._item

type: property

modo.item.Joint._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.Joint.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.Joint.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.Joint.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.Joint.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.Joint.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.Joint.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.Joint.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.Joint.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.Joint.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.Joint.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.Joint.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.Joint.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.Joint.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.Joint.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Joint.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Joint.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Joint.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Joint.scene

type: property

modo.item.Joint.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.Joint.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Joint.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Joint.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.Joint.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Keyframes

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Keyframes._indexFromTime(self,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Keyframes.add(self,val,time)

type: instancemethod

doc: Adds a new keyframe at the specified time. If no time value is passed as an argument a keyframe is set at the current time. :param time: optional time (in seconds) to add a keyframe at. :type time: float :param val: the value to set for the keyframe :type val: int or float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Keyframes.delete(self)

type: instancemethod

doc: Deletes the current key

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Keyframes.first(self)

type: instancemethod

doc: Go to the first keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Keyframes.getSlopeType(self,side)

type: instancemethod

doc: Returns the slope type for either side of a keyframe. :returns: a tuple of the slope type set for the side of the keyframe specified and whether the slope is weighted or not. :rtype: (int, int)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Keyframes.last(self)

type: instancemethod

doc: Go to the last keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Keyframes.next(self)

type: instancemethod

doc: Go to the next keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Keyframes.numKeys

type: property

doc: :getter: Returns the number of keyframes found :rtype: int

modo.item.Keyframes.prev(self)

type: instancemethod

doc: Go to the previous keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Keyframes.setIndex(self,index)

type: instancemethod

doc: Go to the keyframe by index

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Keyframes.setSlopeType(self,stype,side)

type: instancemethod

doc: Sets the slope type for either side of a keyframe - **SLOPE_DIRECT** the slope of the tangent is set based on the value stored in the key. - **SLOPE_AUTO** the slope of the tangent is calculated automatically with regard to surrounding keys. This is similar to the slope adjustments made by TCB curves. - **SLOPE_LINEAR_IN** the slope of the tangent is calculated to align with the previous key's value. - **SLOPE_LINEAR_OUT** the slope of the tangent is calculated to align with the next key's value. - **SLOPE_FLAT** The slope of the tangent is set to zero. - **SLOPE_AUTOFLAT** the same as auto but if a neighboring key has the same value as the key the slope is set to zero. - **SLOPE_STEPPED** Maintains the value of the previous key between pairs of keys. :param stype: set the slope type for the current keyframe. Can be one of: | lx.symbol.iSLOPE_AUTO | lx.symbol.iSLOPE_AUTOFLAT | lx.symbol.iSLOPE_DIRECT | lx.symbol.iSLOPE_FLAT | lx.symbol.iSLOPE_LINEAR_IN | lx.symbol.iSLOPE_LINEAR_OUT | lx.symbol.iSLOPE_STEPPED :type stype: int :param side: the side of the key (in or out) the slope type is being set for :type side: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.Keyframes.time

type: property

doc: Returns & sets the time for the current keyframe. :setter: Sets the time :param time: the time to move the key to. :type time: float :getter: Returns the time of the current keyframe :rtype: float

modo.item.Keyframes.value

type: property

doc: Convenience property to get & set value of the current keyframe for the 90% case of an unbroken key. :setter: Sets a value :param val: the value to set for the key. :type val: int or float :getter: Returns the value of an (unbroken) key. :rtype: int or float

modo.item.Light

type: type

doc: Base Light item class. Each light item encapsulates both an lx.object.Item object (via inheritance from the Item class) of a specific modo light type and a corresponding lx.object.Item of type 'lightMaterial' as a :class:`LightMaterial` object via the light's material property. example:: # to set the diffuse color on the currently selected spotlight spotlight = modo.SpotLight() spotlight.material.ch_diffCol.set((0.7, 0.1, 0.5)) .. note:: Although "Light" isn't technically a base class since, like all other classes in modo.item, it inherits from "Item", it does encapsulate modo's 'Light" supertype and can be treated as a kind of 'pseudo' base class for all modo's light types. As such it should not be instantiated directly, create one of the specific light types instead. | :param light: Optional light item object to wrap. Must be a specific type of light, not the light supertype. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid light item selected. :raises TypeError: if the item passed as an argument isn't an instance of a specific subclass of Light.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light._item

type: property

modo.item.Light._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.Light.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.Light.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.Light.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.Light.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.Light.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.Light.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.Light.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.Light.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.Light.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.Light.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.item.Light.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.Light.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.Light.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.Light.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.Light.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Light.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Light.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Light.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Light.scene

type: property

modo.item.Light.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.Light.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Light.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Light.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.Light.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.LightMaterial

type: type

doc: Wraps a light material texture layer item. :param material: the light material item to be wrapped. :type material: lx.object.Item of type lx.symbol.sITYPE_LIGHTMATERIAL

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial._item

type: property

modo.item.LightMaterial._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.LightMaterial.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.LightMaterial.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.LightMaterial.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.LightMaterial.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.LightMaterial.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.LightMaterial.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.LightMaterial.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.LightMaterial.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.LightMaterial.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.LightMaterial.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.light

type: property

doc: :getter: The light item that the material belongs to. :param light_item: the light item to parent the material layer to. :type light_item: an instance of one of the modo.Light types or either lx.object.Item or lxu.object.Item of a specific light item type :returns: the parent light item. :rtype: one of the modo light types.

modo.item.LightMaterial.lightCol

type: property

doc: A wrapper property for the light material item's three diffuse color channels. Returns an :class:`modo.channel.Channel` object :getter: Returns a channelTriple object. :rtype: modo.channel.channelTriple

modo.item.LightMaterial.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.LightMaterial.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.LightMaterial.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.LightMaterial.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.LightMaterial.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.scatteringCol

type: property

doc: :getter: A wrapper property for the light material item's three scattering color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.item.LightMaterial.scene

type: property

modo.item.LightMaterial.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.LightMaterial.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LightMaterial.shadCol

type: property

doc: :getter: A wrapper property for the light material item's three shadow color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.item.LightMaterial.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.LightMaterial.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Locator

type: type

doc: Locator item class. Takes an optional 'locator' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'locator' or an item name or ID to look up. If no locator item is supplied as an argument an attempt will be made to wrap the most recently selected locator item. :param locator: Optional locator item object (type lx.symbol.sITYPE_LOCATOR) or string (item name or ID) to look up. :type locator: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the locator argument but no item with that name/ID can be found. Hint: Items of other locator derived types should be casted as LocatorSuperType, casting to this class will fail.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator._item

type: property

modo.item.Locator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.Locator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.Locator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.Locator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.Locator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.Locator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.Locator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.Locator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.Locator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.Locator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.Locator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.Locator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.Locator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.Locator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.Locator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Locator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Locator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Locator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Locator.scene

type: property

modo.item.Locator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.Locator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Locator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Locator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.Locator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.LocatorSuperType

type: type

doc: The LocatorSuperType reflects all items that can be seen and transformed in the 3d view. Locators have transform items that hold the respective transform channels, such as position and rotation.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType._item

type: property

modo.item.LocatorSuperType._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.LocatorSuperType.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.LocatorSuperType.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.LocatorSuperType.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.LocatorSuperType.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.LocatorSuperType.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.LocatorSuperType.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.LocatorSuperType.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.LocatorSuperType.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.LocatorSuperType.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.LocatorSuperType.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.LocatorSuperType.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.LocatorSuperType.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.LocatorSuperType.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.LocatorSuperType.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.LocatorSuperType.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.LocatorSuperType.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.LocatorSuperType.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.LocatorSuperType.scene

type: property

modo.item.LocatorSuperType.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.LocatorSuperType.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.LocatorSuperType.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.LocatorSuperType.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.LocatorSuperType.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Matrix4

type: type

doc: Matrix class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4._getIdentity

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4._matrix_calcRotation

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4._matrix_vectorMultiply

type: function

doc: :param matrix: :param vector: :param result: :return:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4._MatrixToEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4._rotOrderToList

type: function

doc: takes a string in form of 'xyz' and returns a list in form of [0,1,2]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4.asEuler(self,degrees,order)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4.asRotateMatrix(self)

type: instancemethod

doc: Removes the translation part of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4.copy(self)

type: instancemethod

doc: :return: A copy of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4.determinant(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4.fromEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4.invert(self)

type: instancemethod

doc: Inverts this Matrix in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4.inverted(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4.position

type: property

doc: :getter: Returns the translation part of this matrix :rtype: tuple :setter: Sets the translation part of this matrix :param position: Position :type position: iterable

modo.item.Matrix4.scale(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4.set(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4.setIdentity(self)

type: instancemethod

doc: Set this matrix to it's identity

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4.transpose(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Matrix4.transposed(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal. It returns a new transposed matrix.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Mesh

type: type

doc: Mesh item class. Takes an optional 'mesh' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'mesh' or an item name or ID to look up. If no mesh item is supplied as an argument an attempt will be made to wrap the most recently selected mesh layer. :param mesh: Optional mesh item object (type lx.symbol.sITYPE_MESH) or string (item name or ID) to look up. :type mesh: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid mesh item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'mesh' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the mesh argument but no item with that name/ID can be found. The mesh geometry can be accessed by the :class:`geometry` attribute. .. py:attribute:: geometry :rtype: :class:`MeshGeometry`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh._item

type: property

modo.item.Mesh._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.Mesh.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.Mesh.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.Mesh.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.Mesh.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.geometry

type: property

modo.item.Mesh.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.Mesh.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.Mesh.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.Mesh.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.Mesh.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.Mesh.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.Mesh.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.Mesh.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.Mesh.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.Mesh.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.Mesh.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Mesh.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Mesh.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Mesh.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Mesh.scene

type: property

modo.item.Mesh.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.Mesh.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Mesh.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Mesh.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.Mesh.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.MeshGeometry

type: type

doc: A class wrapped around lx.object.Mesh that provides access to geometry of a given Mesh Item :param item: Input item :type item: type lx.object.Item :param mode: Mode in which to access the mesh. Possible values: "write", "read", "deformed" :type mode: string. Note: References are always read only. :return: Instance of MeshGeometry :raises LookupError: If item was passed as string and could not be found in the scene :raises TypeError: If the passed item is not of type lx.object.Item :raises TypeError: If the passed item is not compatible with the mesh type example:: scene = modo.scene.current() # Get the selected mesh for mesh in scene.selectedByType("mesh")[:1]: # Print the number of vertices print len(mesh.geometry.vertices) # Print point position by index print mesh.geometry.vertices[4] # Set point position by index mesh.geometry.vertices[4] = (1,2,3) # Iterate all vertices and move them by 0.1 in x for point in mesh.geometry.vertices: point += (0.1, 0, 0) # Update to see mesh changes mesh.geometry.setMeshEdits() .. py:attribute:: vertices :rtype: :class:`MeshVertices` .. py:attribute:: edges :rtype: :class:`MeshEdges` .. py:attribute:: polygons :rtype: :class:`MeshPolygons` .. py:attribute:: vmaps :rtype: :class:`MeshMaps`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.item.MeshGeometry._item

type: property

modo.item.MeshGeometry._SEL_SVC

type: Selection

modo.item.MeshGeometry._UNDO_SVC

type: Undo

modo.item.MeshGeometry.accessMode

type: property

modo.item.MeshGeometry.boundingBox

type: property

doc: Get the bounding box of this mesh :getter: Returns a tuple representing the two corners of the bounding box

modo.item.MeshGeometry.getMeshCenter(self)

type: instancemethod

doc: :return: Center position of the bounding box

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.item.MeshGeometry.internalMesh

type: property

doc: :getter: Returns the wrapped lx.object.Mesh object

modo.item.MeshGeometry.numEdges

type: property

doc: :getter: returns the vertex count of this mesh

modo.item.MeshGeometry.numPolygons

type: property

doc: :getter: returns the polygon count of this mesh

modo.item.MeshGeometry.numVertices

type: property

doc: :getter: returns the vertex count of this mesh

modo.item.MeshGeometry.setAccessMode(self,value,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.item.MeshGeometry.setMeshEdits(self,editType)

type: instancemethod

doc: Updates mesh edits applying previous changes. :param lx.symbol.f_MESHEDIT_* editType: The type of change to set. Defaults to all.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.item.PhotometricLight

type: type

doc: Photometric (ies) light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Photometric Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Photometric Light item. :param light: Optional Photometric light item object (type lx.symbol.sITYPE_PHOTOMETRYLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Photometric light item selected. :raises TypeError: if the item passed as an argument isn't either a Photometric light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight._item

type: property

modo.item.PhotometricLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.PhotometricLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.PhotometricLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.PhotometricLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.PhotometricLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.PhotometricLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.PhotometricLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.PhotometricLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.PhotometricLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.PhotometricLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.PhotometricLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.item.PhotometricLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.PhotometricLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.PhotometricLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.PhotometricLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.PhotometricLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.PhotometricLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.PhotometricLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.PhotometricLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.PhotometricLight.scene

type: property

modo.item.PhotometricLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.PhotometricLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PhotometricLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.PhotometricLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.PhotometricLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.PointLight

type: type

doc: Point light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Point Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Point Light item. :param light: Optional Point light item object (type lx.symbol.sITYPE_POINTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Point light item selected. :raises TypeError: if the item passed as an argument isn't either a Point light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight._item

type: property

modo.item.PointLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.PointLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.PointLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.PointLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.PointLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.PointLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.PointLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.PointLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.PointLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.PointLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.PointLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.item.PointLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.PointLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.PointLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.PointLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.PointLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.PointLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.PointLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.PointLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.PointLight.scene

type: property

modo.item.PointLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.PointLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.PointLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.PointLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.PointLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Portal

type: type

doc: Portal item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Portal' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Portal item. :param light: Optional Portal item object (type 'portal') or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Portal item selected. :raises TypeError: if the item passed as an argument isn't either a Portal item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal._item

type: property

modo.item.Portal._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.Portal.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.Portal.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.Portal.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.Portal.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.Portal.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.Portal.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.Portal.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.Portal.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.Portal.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.Portal.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.item.Portal.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.Portal.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.Portal.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.Portal.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.Portal.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Portal.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Portal.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Portal.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.Portal.scene

type: property

modo.item.Portal.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.Portal.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.Portal.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.Portal.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.Portal.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.RenderPassGroup

type: type

doc: Render pass group :param groupItem: either a group item or an item name/ID to look up. :type groupItem: lx.object.item or modo.item.Item :raises TypeError: if the item is not a 'Group" item. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup._item

type: property

modo.item.RenderPassGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.addPass(self,name)

type: instancemethod

doc: Add a render pass item to the group. :param name: optional name for the render pass :type name: basestring :return: the render pass item. :rtype: modo.item.ActionClip

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.RenderPassGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.RenderPassGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.RenderPassGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.RenderPassGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.item.RenderPassGroup.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.item.RenderPassGroup.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.RenderPassGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.RenderPassGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.RenderPassGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.RenderPassGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.item.RenderPassGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.RenderPassGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.RenderPassGroup.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.item.RenderPassGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.RenderPassGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.RenderPassGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.RenderPassGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.RenderPassGroup.passes

type: property

doc: :getter: Returns a lst of render passes in the group. :returns: list of render pass items :rtype: list of modo.item.ActionClip

modo.item.RenderPassGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.scene

type: property

modo.item.RenderPassGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.RenderPassGroup.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.RenderPassGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.RenderPassGroup.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.item.scene

type: module

doc: .. module:: modo.scene :synopsis: Scene class and scene level utility functions. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.item.scene.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.item.scene.ChannelRead contents:
  • modo.item.scene.ChannelRead.__class__
  • modo.item.scene.ChannelRead.__delattr__
  • modo.item.scene.ChannelRead.__dict__
  • modo.item.scene.ChannelRead.__doc__
  • modo.item.scene.ChannelRead.__format__
  • modo.item.scene.ChannelRead.__getattr__
  • modo.item.scene.ChannelRead.__getattribute__
  • modo.item.scene.ChannelRead.__hash__
  • modo.item.scene.ChannelRead.__init__
  • modo.item.scene.ChannelRead.__module__
  • modo.item.scene.ChannelRead.__new__
  • modo.item.scene.ChannelRead.__reduce__
  • modo.item.scene.ChannelRead.__reduce_ex__
  • modo.item.scene.ChannelRead.__repr__
  • modo.item.scene.ChannelRead.__setattr__
  • modo.item.scene.ChannelRead.__sizeof__
  • modo.item.scene.ChannelRead.__str__
  • modo.item.scene.ChannelRead.__subclasshook__
  • modo.item.scene.ChannelRead.__weakref__
  • modo.item.scene.ChannelRead.set

modo.item.scene.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.scene.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.item.scene.ChannelWrite contents:
  • modo.item.scene.ChannelWrite.__class__
  • modo.item.scene.ChannelWrite.__delattr__
  • modo.item.scene.ChannelWrite.__dict__
  • modo.item.scene.ChannelWrite.__doc__
  • modo.item.scene.ChannelWrite.__format__
  • modo.item.scene.ChannelWrite.__getattr__
  • modo.item.scene.ChannelWrite.__getattribute__
  • modo.item.scene.ChannelWrite.__hash__
  • modo.item.scene.ChannelWrite.__init__
  • modo.item.scene.ChannelWrite.__module__
  • modo.item.scene.ChannelWrite.__new__
  • modo.item.scene.ChannelWrite.__reduce__
  • modo.item.scene.ChannelWrite.__reduce_ex__
  • modo.item.scene.ChannelWrite.__repr__
  • modo.item.scene.ChannelWrite.__setattr__
  • modo.item.scene.ChannelWrite.__sizeof__
  • modo.item.scene.ChannelWrite.__str__
  • modo.item.scene.ChannelWrite.__subclasshook__
  • modo.item.scene.ChannelWrite.__weakref__
  • modo.item.scene.ChannelWrite.set

modo.item.scene.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.item.scene.current

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.item.scene.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.scene.Scene

type: type

doc: The main scene class. Takes an optional lx.object.Scene object as an argument. If none is provided (the default) then the currently selected scene is used which will mostly be the general case. The module function :func:`sceneList` makes use of the scene parameter to return a list of open scenes as modo.scene.Scene objects. :param scene: Optional scene object to wrap. :type scene: lx.object.Scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene._allItems(self)

type: instancemethod

doc: Utility function to get all items of a scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene._Scene__ItemAdd(self,groupType)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene._Scene__setupTextureLayerType(self,newItem)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.actors

type: property

doc: Returns a list of all actors in the scene :getter: Returns a list of Actor objects found in this scene :rtype: list

modo.item.scene.Scene.addActor(self,name,items,makeActive)

type: instancemethod

doc: Add a new actor to the scene :returns modo.item.Actor: Actor item object :param basestring name: optional name :param list items: list of items for the actor to contain

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.addCamera(self,name)

type: instancemethod

doc: Add a new camera item to the scene :returns: camera item :rtype: modo.item.Camera :param name: optional name for the camera. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.addGroup(self,name,gtype)

type: instancemethod

doc: Add a new group item to the scene :returns: group item :rtype: modo.item.Group :param name: optional name for the group item. :type name: basestring :param gtype: optional group type, can be one of the default group types ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader') or any other string to create a custom group type. Default is an empty string which creates a 'Genera' group type. :type gtype: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.addItem(self,itype,name)

type: instancemethod

doc: Add a new item to the scene :returns: item :rtype: modo.item.item :param itype: item type :type itype: modo.Constant :param name: optional name for the item. :type name: basestring :raises TypeError: When failing

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.addJointLocator(self,name,parent)

type: instancemethod

doc: Adds a new joint to the scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.addMaterial(self,matType,name,index)

type: instancemethod

doc: Adds a new material to the scene :param modo.c.MATERIAL_* matType: Type of material to create :param name: Optional name for the material :returns Item: The material item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.addMesh(self,name)

type: instancemethod

doc: Add a new mesh item to the scene :returns: mesh item :rtype: modo.item.Mesh :param name: optional name for the mesh. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.addRenderPassGroup(self,name)

type: instancemethod

doc: Add a render pass group to the scene :returns: render pass group. :rtype: modo.item.RenderPassGroup :param name: optional name for the render pass group. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.camera(self,cam)

type: instancemethod

doc: Returns a camera item in the scene. The supplied argument can be either a string (camera ID or name) or an integer (camera index in the scene's collection of cameras) :param cam: the camera :type cam: basestring or int :returns: camera item :rtype: modo.item.Camera

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.cameraCount

type: property

doc: Number of cameras in the scene. :getter: Returns the number of camera items. :rtype: int

modo.item.scene.Scene.cameras

type: property

doc: Returns a list of all the camera items in the scene as modo.item.Camera objects. :getter: Returns a list of the camera items in the scene. :rtype: list of modo.item.Camera

modo.item.scene.Scene.currentRange

type: property

doc: Set or read the current frame range start and end frame value should be passed in as a tuple. :setter: Sets the range :param frange: frame range - a tuple of ints (start, end). :type frange: tuple :Getter: Returns the start and end frames. :rtype: tuple :exception ValueError: if supplied start frame is higher than end frame.

modo.item.scene.Scene.deformers(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.deselect(self,itemObj)

type: instancemethod

doc: Deselect an item. :param itemObj: the item to deselect. Clears the entire selection if None :type itemObj: basestring (item name or ID) or instance of either lx.object.Item or modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.duplicateItem(self,item,instance)

type: instancemethod

doc: Creates and returns a duplicate of the passed item :returns item: Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.filename

type: property

doc: File path of the scene. :getter: Returns the file path of the scene or 'None' if not yet saved. :rtype: basestring or None

modo.item.scene.Scene.fps

type: property

doc: Scene frames per second. .. note:: There is no way to set the fps value from the Python API for any scene other than the currently selected one. Therefore, for any other scene the property will be read only and attempts to write to it will throw an AttributeError. | :getter: Returns the Frames Per Second :rtype: float :setter: Sets the Frames Per Second :param fps: Scene frames per second. :type fps: float :raises: AttributeError

modo.item.scene.Scene.getGroups(self,gtype)

type: instancemethod

doc: Returns all groups of the given kind :param gtype: optional group type, can be one of the default group types ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader') or any other string to create a custom group type. Default is an empty string which creates a 'Genera' group type. You can also pass a list of multiple group types. :returns list: List of groups matching the type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.groups

type: property

doc: Returns a list of all the group items in the scene as modo.item.Group objects. :getter: Returns a list of the group items in the scene. :rtype: list of modo.item.Group

modo.item.scene.Scene.item(self,name)

type: instancemethod

doc: Look up item by name :param string item: Name to look for :returns item: Found item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.itemCount(self,itype)

type: instancemethod

doc: The number of items of a specified type in the scene. :param itype: type of the items. :type itype: int or basestring :returns: the number of items of the specified type in the scene. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.items(self,itype,name,superType)

type: instancemethod

doc: List of items of the specified type in the scene. :param itype: the item type. :type itype: :param basestring name: Optionally filter result by this text. Can use * and ? wildcards for globbing. :param bool superType: If True, all items that have 'itype' as superType are listed. Else, only items of specifically that type are returned. :returns: list of the items of the specified type in the scene. If itype is None, all items in the scene are returned. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.iterItems(self,itype,name,superType)

type: instancemethod

doc: Same as items(), but returns a generator object.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.lightCount

type: property

doc: Number of lights in the scene. :getter: Returns the number of light items. :rtype: int

modo.item.scene.Scene.locators

type: property

modo.item.scene.Scene.meshCount

type: property

doc: Number of mesh items in the scene. :getter: Returns the number of mesh items. :rtype: int

modo.item.scene.Scene.meshes

type: property

doc: Returns a list of all the mesh items in the scene as modo.item.Mesh objects. :getter: Returns a list of the mesh items in the scene. :rtype: list of modo.item.Mesh

modo.item.scene.Scene.name

type: property

doc: Friendly name of the scene. :getter: Returns the name of the scene. :rtype: basestring

modo.item.scene.Scene.removeItems(self,itm,children)

type: instancemethod

doc: :param Item: Item to remove from the scene :param bool children: If True, all found children are deleted also

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.renderCamera

type: property

doc: Get & set the scene's current render camera :setter: Set the scene's current render camera :param camera: the camera item to set as the current render camera. :type camera: lx.object.Item of type 'Camera' :getter: Returns the current render camera. :rtype: modo.Item.Camera

modo.item.scene.Scene.renderItem

type: property

doc: :getter: Returns the first found render item of the scene :rtype: Item

modo.item.scene.Scene.renderPassGroups

type: property

doc: Returns a list of all the render pass group items in the scene as modo.item.RenderPassGroup objects. :getter: Returns a list of the render pass group items in the scene. :rtype: list of modo.item.Group

modo.item.scene.Scene.sceneItem

type: property

doc: The scene's 'scene item' :getter: Returns the scene's scene item. :rtype: lxdt.item.Item (type lx.symbol.sITYPE_SCENE)

modo.item.scene.Scene.sceneRange

type: property

doc: Set or read the scene's frame range start and end frame value should be passed in as a tuple. :setter: Sets the range :param frange: frame range - a tuple of ints (start, end). :type frange: tuple :getter: Returns the start and end frames. :rtype: tuple :exception ValueError: if supplied start frame is higher than end frame.

modo.item.scene.Scene.select(self,itemObj,add)

type: instancemethod

doc: :param itemObj: the item to select. :type item: basestring (item name or ID) or instance of either lx.object.Item or modo.item.Item :param add: whether to add to the current selection, False replaces the current selection. :type add: bool Note:: To clear the selection of the scene, please use deselect() instead.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.Scene.selected

type: property

doc: Selected items in the scene. :getter: Returns the selected items :rtype: list

modo.item.scene.Scene.selectedByType(self,itype,superType)

type: instancemethod

doc: Returns the selected items of a specific type as modo.item.Item objects. :param itype: item type to filter on. :type itype: int or string :return: selcted items of specified type. :param bool superType: If True, all items derived fom itype are listed. Otherwise only items of the exact type of itype. :rtype: list of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.sceneList

type: function

doc: Get a list of all the currently open scenes. :returns: Collection of currently open scenes as modo.scene.Scene objects. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.item.scene.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.scene.util.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.item.scene.util.collections

type: module

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.item.scene.util.collections._abcoll

type: module

doc: Abstract Base Classes (ABCs) for collections, according to PEP 3119. DON'T USE THIS MODULE DIRECTLY! The classes here should be imported via collections; they are defined here only to alleviate certain bootstrapping issues. Unit tests are in test_collections.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll._hasattr

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.item.scene.util.collections._abcoll.ABCMeta

type: type

doc: Metaclass for defining Abstract Base Classes (ABCs). Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as 'virtual subclasses' -- these and their descendants will be considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won't show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via super()).

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\abc.pyc

modo.item.scene.util.collections._abcoll.abstractmethod

type: function

doc: A decorator indicating abstract methods. Requires that the metaclass is ABCMeta or derived from it. A class that has a metaclass derived from ABCMeta cannot be instantiated unless all of its abstract methods are overridden. The abstract methods can be called using any of the normal 'super' call mechanisms. Usage: class C: __metaclass__ = ABCMeta @abstractmethod def my_abstract_method(self, ...): ...

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.item.scene.util.collections._abcoll.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._abcoll.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.item.scene.util.collections._abcoll.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections._chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.item.scene.util.collections._chain contents:
  • modo.item.scene.util.collections._chain.__class__
  • modo.item.scene.util.collections._chain.__delattr__
  • modo.item.scene.util.collections._chain.__doc__
  • modo.item.scene.util.collections._chain.__format__
  • modo.item.scene.util.collections._chain.__getattribute__
  • modo.item.scene.util.collections._chain.__hash__
  • modo.item.scene.util.collections._chain.__init__
  • modo.item.scene.util.collections._chain.__iter__
  • modo.item.scene.util.collections._chain.__new__
  • modo.item.scene.util.collections._chain.__reduce__
  • modo.item.scene.util.collections._chain.__reduce_ex__
  • modo.item.scene.util.collections._chain.__repr__
  • modo.item.scene.util.collections._chain.__setattr__
  • modo.item.scene.util.collections._chain.__sizeof__
  • modo.item.scene.util.collections._chain.__str__
  • modo.item.scene.util.collections._chain.__subclasshook__
  • modo.item.scene.util.collections._chain.from_iterable
  • modo.item.scene.util.collections._chain.next

modo.item.scene.util.collections._chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.item.scene.util.collections._chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.item.scene.util.collections._get_ident()

type: builtin_function_or_method

doc: get_ident() -> integer Return a non-zero integer that uniquely identifies the current thread amongst other threads that exist simultaneously. This may be used to identify per-thread resources. Even though on some platforms threads identities may appear to be allocated consecutive numbers starting at 1, this behavior should not be relied upon, and the number should be seen purely as a magic cookie. A thread's identity may be reused for another thread after it exits.

modo.item.scene.util.collections._heapq

type: module

doc: Heap queue algorithm (a.k.a. priority queue). Heaps are arrays for which a[k] <= a[2*k+1] and a[k] <= a[2*k+2] for all k, counting elements from 0. For the sake of comparison, non-existing elements are considered to be infinite. The interesting property of a heap is that a[0] is always its smallest element. Usage: heap = [] # creates an empty heap heappush(heap, item) # pushes a new item on the heap item = heappop(heap) # pops the smallest item from the heap item = heap[0] # smallest item on the heap without popping it heapify(x) # transforms list into a heap, in-place, in linear time item = heapreplace(heap, item) # pops and returns smallest item, and adds # new item; the heap size is unchanged Our API differs from textbook heap algorithms as follows: - We use 0-based indexing. This makes the relationship between the index for a node and the indexes for its children slightly less obvious, but is more suitable since Python uses 0-based indexing. - Our heappop() method returns the smallest item, not the largest. These two make it possible to view the heap as a regular Python list without surprises: heap[0] is the smallest item, and heap.sort() maintains the heap invariant!

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\heapq.pyc

modo.item.scene.util.collections._heapq._nlargest()

type: builtin_function_or_method

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, reverse=True)[:n]

modo.item.scene.util.collections._heapq._nsmallest()

type: builtin_function_or_method

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable)[:n]

modo.item.scene.util.collections._heapq._siftdown

type: function

file: .\Lib\heapq.py

modo.item.scene.util.collections._heapq._siftup

type: function

file: .\Lib\heapq.py

modo.item.scene.util.collections._heapq.bisect

type: module

doc: Bisection algorithms.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\bisect.pyc

modo.item.scene.util.collections._heapq.chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

modo.item.scene.util.collections._heapq.cmp_lt

type: function

file: .\Lib\heapq.py

modo.item.scene.util.collections._heapq.count

type: type

doc: count(start=0, step=1) --> count object Return a count object whose .next() method returns consecutive values. Equivalent to: def count(firstval=0, step=1): x = firstval while 1: yield x x += step

modo.item.scene.util.collections._heapq.heapify()

type: builtin_function_or_method

doc: Transform list into a heap, in-place, in O(len(heap)) time.

modo.item.scene.util.collections._heapq.heappop()

type: builtin_function_or_method

doc: Pop the smallest item off the heap, maintaining the heap invariant.

modo.item.scene.util.collections._heapq.heappush()

type: builtin_function_or_method

doc: Push item onto heap, maintaining the heap invariant.

modo.item.scene.util.collections._heapq.heappushpop()

type: builtin_function_or_method

doc: Push item on the heap, then pop and return the smallest item from the heap. The combined action runs more efficiently than heappush() followed by a separate call to heappop().

modo.item.scene.util.collections._heapq.heapreplace()

type: builtin_function_or_method

doc: Pop and return the current smallest value, and add the new item. This is more efficient than heappop() followed by heappush(), and can be more appropriate when using a fixed-size heap. Note that the value returned may be larger than item! That constrains reasonable uses of this routine unless written as part of a conditional replacement: if item > heap[0]: item = heapreplace(heap, item)

modo.item.scene.util.collections._heapq.imap

type: type

doc: imap(func, *iterables) --> imap object Make an iterator that computes the function using arguments from each of the iterables. Like map() except that it returns an iterator instead of a list and that it stops when the shortest iterable is exhausted instead of filling in None for shorter iterables.

modo.item.scene.util.collections._heapq.islice

type: type

doc: islice(iterable, [start,] stop [, step]) --> islice object Return an iterator whose next() method returns selected values from an iterable. If start is specified, will skip all preceding elements; otherwise, start defaults to zero. Step defaults to one. If specified as another value, step determines how many values are skipped between successive calls. Works like a slice() on a list but returns an iterator.

modo.item.scene.util.collections._heapq.itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

modo.item.scene.util.collections._heapq.izip

type: type

doc: izip(iter1 [,iter2 [...]]) --> izip object Return a izip object whose .next() method returns a tuple where the i-th element comes from the i-th iterable argument. The .next() method continues until the shortest iterable in the argument sequence is exhausted and then it raises StopIteration. Works like the zip() function but consumes less memory by returning an iterator instead of a list.

modo.item.scene.util.collections._heapq.merge

type: function

doc: Merge multiple sorted inputs into a single sorted output. Similar to sorted(itertools.chain(*iterables)) but returns a generator, does not pull the data into memory all at once, and assumes that each of the input streams is already sorted (smallest to largest). >>> list(merge([1,3,5,7], [0,2,4,8], [5,10,15,20], [], [25])) [0, 1, 2, 3, 4, 5, 5, 7, 8, 10, 15, 20, 25]

file: .\Lib\heapq.py

modo.item.scene.util.collections._heapq.nlargest

type: function

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, key=key, reverse=True)[:n]

file: .\Lib\heapq.py

modo.item.scene.util.collections._heapq.nsmallest

type: function

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable, key=key)[:n]

file: .\Lib\heapq.py

modo.item.scene.util.collections._heapq.repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

modo.item.scene.util.collections._heapq.tee()

type: builtin_function_or_method

doc: tee(iterable, n=2) --> tuple of n independent iterators.

modo.item.scene.util.collections._iskeyword()

type: builtin_function_or_method

doc: x.__contains__(y) <==> y in x.

modo.item.scene.util.collections._itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.item.scene.util.collections._itemgetter contents:
  • modo.item.scene.util.collections._itemgetter.__call__
  • modo.item.scene.util.collections._itemgetter.__class__
  • modo.item.scene.util.collections._itemgetter.__delattr__
  • modo.item.scene.util.collections._itemgetter.__doc__
  • modo.item.scene.util.collections._itemgetter.__format__
  • modo.item.scene.util.collections._itemgetter.__getattribute__
  • modo.item.scene.util.collections._itemgetter.__hash__
  • modo.item.scene.util.collections._itemgetter.__init__
  • modo.item.scene.util.collections._itemgetter.__new__
  • modo.item.scene.util.collections._itemgetter.__reduce__
  • modo.item.scene.util.collections._itemgetter.__reduce_ex__
  • modo.item.scene.util.collections._itemgetter.__repr__
  • modo.item.scene.util.collections._itemgetter.__setattr__
  • modo.item.scene.util.collections._itemgetter.__sizeof__
  • modo.item.scene.util.collections._itemgetter.__str__
  • modo.item.scene.util.collections._itemgetter.__subclasshook__
modo.item.scene.util.collections._repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.item.scene.util.collections._repeat contents:
  • modo.item.scene.util.collections._repeat.__class__
  • modo.item.scene.util.collections._repeat.__delattr__
  • modo.item.scene.util.collections._repeat.__doc__
  • modo.item.scene.util.collections._repeat.__format__
  • modo.item.scene.util.collections._repeat.__getattribute__
  • modo.item.scene.util.collections._repeat.__hash__
  • modo.item.scene.util.collections._repeat.__init__
  • modo.item.scene.util.collections._repeat.__iter__
  • modo.item.scene.util.collections._repeat.__length_hint__
  • modo.item.scene.util.collections._repeat.__new__
  • modo.item.scene.util.collections._repeat.__reduce__
  • modo.item.scene.util.collections._repeat.__reduce_ex__
  • modo.item.scene.util.collections._repeat.__repr__
  • modo.item.scene.util.collections._repeat.__setattr__
  • modo.item.scene.util.collections._repeat.__sizeof__
  • modo.item.scene.util.collections._repeat.__str__
  • modo.item.scene.util.collections._repeat.__subclasshook__
  • modo.item.scene.util.collections._repeat.next

modo.item.scene.util.collections._repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.item.scene.util.collections._starmap

type: type

doc: starmap(function, sequence) --> starmap object Return an iterator whose values are returned from the function evaluated with a argument tuple taken from the given sequence.

    modo.item.scene.util.collections._starmap contents:
  • modo.item.scene.util.collections._starmap.__class__
  • modo.item.scene.util.collections._starmap.__delattr__
  • modo.item.scene.util.collections._starmap.__doc__
  • modo.item.scene.util.collections._starmap.__format__
  • modo.item.scene.util.collections._starmap.__getattribute__
  • modo.item.scene.util.collections._starmap.__hash__
  • modo.item.scene.util.collections._starmap.__init__
  • modo.item.scene.util.collections._starmap.__iter__
  • modo.item.scene.util.collections._starmap.__new__
  • modo.item.scene.util.collections._starmap.__reduce__
  • modo.item.scene.util.collections._starmap.__reduce_ex__
  • modo.item.scene.util.collections._starmap.__repr__
  • modo.item.scene.util.collections._starmap.__setattr__
  • modo.item.scene.util.collections._starmap.__sizeof__
  • modo.item.scene.util.collections._starmap.__str__
  • modo.item.scene.util.collections._starmap.__subclasshook__
  • modo.item.scene.util.collections._starmap.next

modo.item.scene.util.collections._starmap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.item.scene.util.collections._sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.item.scene.util.collections._sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.item.scene.util.collections._sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.item.scene.util.collections._sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.item.scene.util.collections._sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.scene.util.collections._sys.api_version

type: int

modo.item.scene.util.collections._sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.scene.util.collections._sys.byteorder

type: str

modo.item.scene.util.collections._sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.item.scene.util.collections._sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.item.scene.util.collections._sys.copyright

type: str

modo.item.scene.util.collections._sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.item.scene.util.collections._sys.dllhandle

type: long

modo.item.scene.util.collections._sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.item.scene.util.collections._sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.item.scene.util.collections._sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.item.scene.util.collections._sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.item.scene.util.collections._sys.exc_type

type: type

doc: Inappropriate argument type.

modo.item.scene.util.collections._sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.item.scene.util.collections._sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.item.scene.util.collections._sys.exec_prefix

type: str

modo.item.scene.util.collections._sys.executable

type: str

modo.item.scene.util.collections._sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.item.scene.util.collections._sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.item.scene.util.collections._sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.item.scene.util.collections._sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.item.scene.util.collections._sys.float_repr_style

type: str

modo.item.scene.util.collections._sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.item.scene.util.collections._sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.item.scene.util.collections._sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.item.scene.util.collections._sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.item.scene.util.collections._sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.item.scene.util.collections._sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.item.scene.util.collections._sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.item.scene.util.collections._sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.item.scene.util.collections._sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.item.scene.util.collections._sys.hexversion

type: int

modo.item.scene.util.collections._sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.item.scene.util.collections._sys.maxint

type: int

modo.item.scene.util.collections._sys.maxsize

type: long

modo.item.scene.util.collections._sys.maxunicode

type: int

modo.item.scene.util.collections._sys.meta_path

type: list

modo.item.scene.util.collections._sys.modules

type: dict

modo.item.scene.util.collections._sys.path

type: list

modo.item.scene.util.collections._sys.path_hooks

type: list

modo.item.scene.util.collections._sys.path_importer_cache

type: dict

modo.item.scene.util.collections._sys.platform

type: str

modo.item.scene.util.collections._sys.prefix

type: str

modo.item.scene.util.collections._sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.item.scene.util.collections._sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.item.scene.util.collections._sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.item.scene.util.collections._sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.item.scene.util.collections._sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.item.scene.util.collections._sys.stderr

type: SESysStdErr

modo.item.scene.util.collections._sys.stdin

type: SESysStdIn

modo.item.scene.util.collections._sys.stdout

type: SESysStdOut

modo.item.scene.util.collections._sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.scene.util.collections._sys.version

type: str

modo.item.scene.util.collections._sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.item.scene.util.collections._sys.warnoptions

type: list

modo.item.scene.util.collections._sys.winver

type: str

modo.item.scene.util.collections.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.Counter

type: type

doc: Dict subclass for counting hashable items. Sometimes called a bag or multiset. Elements are stored as dictionary keys and their counts are stored as dictionary values. >>> c = Counter('abcdeabcdabcaba') # count elements from a string >>> c.most_common(3) # three most common elements [('a', 5), ('b', 4), ('c', 3)] >>> sorted(c) # list all unique elements ['a', 'b', 'c', 'd', 'e'] >>> ''.join(sorted(c.elements())) # list elements with repetitions 'aaaaabbbbcccdde' >>> sum(c.values()) # total of all counts 15 >>> c['a'] # count of letter 'a' 5 >>> for elem in 'shazam': # update counts from an iterable ... c[elem] += 1 # by adding 1 to each element's count >>> c['a'] # now there are seven 'a' 7 >>> del c['b'] # remove all 'b' >>> c['b'] # now there are zero 'b' 0 >>> d = Counter('simsalabim') # make another counter >>> c.update(d) # add in the second counter >>> c['a'] # now there are nine 'a' 9 >>> c.clear() # empty the counter >>> c Counter() Note: If a count is set to zero or reduced to zero, it will remain in the counter until the entry is deleted or the counter is cleared: >>> c = Counter('aaabbc') >>> c['b'] -= 2 # reduce the count of 'b' by two >>> c.most_common() # 'b' is still in, but its count is zero [('a', 3), ('c', 1), ('b', 0)]

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.item.scene.util.collections.Counter.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.item.scene.util.collections.Counter.copy(self)

type: instancemethod

doc: Return a shallow copy.

file: .\Lib\collections.py

modo.item.scene.util.collections.Counter.elements(self)

type: instancemethod

doc: Iterator over elements repeating each as many times as its count. >>> c = Counter('ABCABC') >>> sorted(c.elements()) ['A', 'A', 'B', 'B', 'C', 'C'] # Knuth's example for prime factors of 1836: 2**2 * 3**3 * 17**1 >>> prime_factors = Counter({2: 2, 3: 3, 17: 1}) >>> product = 1 >>> for factor in prime_factors.elements(): # loop over factors ... product *= factor # and multiply them >>> product 1836 Note, if an element's count has been set to zero or is a negative number, elements() will ignore it.

file: .\Lib\collections.py

modo.item.scene.util.collections.Counter.fromkeys(cls,iterable,v)

type: instancemethod

file: .\Lib\collections.py

modo.item.scene.util.collections.Counter.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.item.scene.util.collections.Counter.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.item.scene.util.collections.Counter.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.item.scene.util.collections.Counter.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.item.scene.util.collections.Counter.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.item.scene.util.collections.Counter.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.item.scene.util.collections.Counter.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.item.scene.util.collections.Counter.most_common(self,n)

type: instancemethod

doc: List the n most common elements and their counts from the most common to the least. If n is None, then list all element counts. >>> Counter('abcdeabcdabcaba').most_common(3) [('a', 5), ('b', 4), ('c', 3)]

file: .\Lib\collections.py

modo.item.scene.util.collections.Counter.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.item.scene.util.collections.Counter.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.item.scene.util.collections.Counter.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.item.scene.util.collections.Counter.subtract(self,iterable)

type: instancemethod

doc: Like dict.update() but subtracts counts instead of replacing them. Counts can be reduced below zero. Both the inputs and outputs are allowed to contain zero and negative counts. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.subtract('witch') # subtract elements from another iterable >>> c.subtract(Counter('watch')) # subtract elements from another counter >>> c['h'] # 2 in which, minus 1 in witch, minus 1 in watch 0 >>> c['w'] # 1 in which, minus 1 in witch, minus 1 in watch -1

file: .\Lib\collections.py

modo.item.scene.util.collections.Counter.update(self,iterable)

type: instancemethod

doc: Like dict.update() but add counts instead of replacing them. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.update('witch') # add elements from another iterable >>> d = Counter('watch') >>> c.update(d) # add elements from another counter >>> c['h'] # four 'h' in which, witch, and watch 4

file: .\Lib\collections.py

modo.item.scene.util.collections.Counter.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.item.scene.util.collections.Counter.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.item.scene.util.collections.Counter.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.item.scene.util.collections.Counter.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.item.scene.util.collections.defaultdict

type: type

doc: defaultdict(default_factory) --> dict with default factory The default factory is called without arguments to produce a new value when a key is not present, in __getitem__ only. A defaultdict compares equal to a dict with the same items.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.item.scene.util.collections.defaultdict.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.item.scene.util.collections.defaultdict.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D.

modo.item.scene.util.collections.defaultdict.default_factory

type: member_descriptor

doc: Factory for default value called by __missing__().

modo.item.scene.util.collections.defaultdict.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.item.scene.util.collections.defaultdict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.item.scene.util.collections.defaultdict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.item.scene.util.collections.defaultdict.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.item.scene.util.collections.defaultdict.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.item.scene.util.collections.defaultdict.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.item.scene.util.collections.defaultdict.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.item.scene.util.collections.defaultdict.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.item.scene.util.collections.defaultdict.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.item.scene.util.collections.defaultdict.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.item.scene.util.collections.defaultdict.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.item.scene.util.collections.defaultdict.update()

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.item.scene.util.collections.defaultdict.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.item.scene.util.collections.defaultdict.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.item.scene.util.collections.defaultdict.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.item.scene.util.collections.defaultdict.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.item.scene.util.collections.deque

type: type

doc: deque(iterable[, maxlen]) --> deque object Build an ordered collection with optimized access from its endpoints.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.item.scene.util.collections.deque.append()

type: method_descriptor

doc: Add an element to the right side of the deque.

modo.item.scene.util.collections.deque.appendleft()

type: method_descriptor

doc: Add an element to the left side of the deque.

modo.item.scene.util.collections.deque.clear()

type: method_descriptor

doc: Remove all elements from the deque.

modo.item.scene.util.collections.deque.count()

type: method_descriptor

doc: D.count(value) -> integer -- return number of occurrences of value

modo.item.scene.util.collections.deque.extend()

type: method_descriptor

doc: Extend the right side of the deque with elements from the iterable

modo.item.scene.util.collections.deque.extendleft()

type: method_descriptor

doc: Extend the left side of the deque with elements from the iterable

modo.item.scene.util.collections.deque.maxlen

type: getset_descriptor

doc: maximum size of a deque or None if unbounded

modo.item.scene.util.collections.deque.pop()

type: method_descriptor

doc: Remove and return the rightmost element.

modo.item.scene.util.collections.deque.popleft()

type: method_descriptor

doc: Remove and return the leftmost element.

modo.item.scene.util.collections.deque.remove()

type: method_descriptor

doc: D.remove(value) -- remove first occurrence of value.

modo.item.scene.util.collections.deque.reverse()

type: method_descriptor

doc: D.reverse() -- reverse *IN PLACE*

modo.item.scene.util.collections.deque.rotate()

type: method_descriptor

doc: Rotate the deque n steps to the right (default n=1). If n is negative, rotates left.

modo.item.scene.util.collections.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.namedtuple

type: function

doc: Returns a new subclass of tuple with named fields. >>> Point = namedtuple('Point', 'x y') >>> Point.__doc__ # docstring for the new class 'Point(x, y)' >>> p = Point(11, y=22) # instantiate with positional args or keywords >>> p[0] + p[1] # indexable like a plain tuple 33 >>> x, y = p # unpack like a regular tuple >>> x, y (11, 22) >>> p.x + p.y # fields also accessable by name 33 >>> d = p._asdict() # convert to a dictionary >>> d['x'] 11 >>> Point(**d) # convert from a dictionary Point(x=11, y=22) >>> p._replace(x=100) # _replace() is like str.replace() but targets named fields Point(x=100, y=22)

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict

type: type

doc: Dictionary that remembers insertion order

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.item.scene.util.collections.OrderedDict._OrderedDict__marker

type: object

doc: The most base type

modo.item.scene.util.collections.OrderedDict._OrderedDict__update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.item.scene.util.collections.OrderedDict.clear(self)

type: instancemethod

doc: od.clear() -> None. Remove all items from od.

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.copy(self)

type: instancemethod

doc: od.copy() -> a shallow copy of od

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.fromkeys(cls,iterable,value)

type: instancemethod

doc: OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S. If not specified, the value defaults to None.

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.item.scene.util.collections.OrderedDict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.item.scene.util.collections.OrderedDict.items(self)

type: instancemethod

doc: od.items() -> list of (key, value) pairs in od

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.iteritems(self)

type: instancemethod

doc: od.iteritems -> an iterator over the (key, value) pairs in od

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.iterkeys(self)

type: instancemethod

doc: od.iterkeys() -> an iterator over the keys in od

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.itervalues(self)

type: instancemethod

doc: od.itervalues -> an iterator over the values in od

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.keys(self)

type: instancemethod

doc: od.keys() -> list of keys in od

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.pop(self,key,default)

type: instancemethod

doc: od.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.popitem(self,last)

type: instancemethod

doc: od.popitem() -> (k, v), return and remove a (key, value) pair. Pairs are returned in LIFO order if last is true or FIFO order if false.

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.setdefault(self,key,default)

type: instancemethod

doc: od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.item.scene.util.collections.OrderedDict.values(self)

type: instancemethod

doc: od.values() -> list of values in od

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.viewitems(self)

type: instancemethod

doc: od.viewitems() -> a set-like object providing a view on od's items

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.viewkeys(self)

type: instancemethod

doc: od.viewkeys() -> a set-like object providing a view on od's keys

file: .\Lib\collections.py

modo.item.scene.util.collections.OrderedDict.viewvalues(self)

type: instancemethod

doc: od.viewvalues() -> an object providing a view on od's values

file: .\Lib\collections.py

modo.item.scene.util.collections.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.collections.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.scene.util.ensureModoItem

type: function

doc: Decorator - ensures that the argument passed as the first parameter to a function is an instance of the modo :class:`Item` class. Should only only be used to decorate methods where the first argument is meant to be an item and ensures that if for any reason an item of either type lx.object.Item or lxu.object.Item gets passed to the method it will get wrapped as an modo.item.Item object before being used.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.scene.util.floatEquals

type: function

doc: Test if two floats are equal :returns bool:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.scene.util.functools

type: module

doc: functools.py - Tools for working with functions and callable objects

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

modo.item.scene.util.functools.cmp_to_key

type: function

doc: Convert a cmp= function into a key= function

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.item.scene.util.functools.partial

type: type

doc: partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

    modo.item.scene.util.functools.partial contents:
  • modo.item.scene.util.functools.partial.__call__
  • modo.item.scene.util.functools.partial.__class__
  • modo.item.scene.util.functools.partial.__delattr__
  • modo.item.scene.util.functools.partial.__dict__
  • modo.item.scene.util.functools.partial.__doc__
  • modo.item.scene.util.functools.partial.__format__
  • modo.item.scene.util.functools.partial.__getattribute__
  • modo.item.scene.util.functools.partial.__hash__
  • modo.item.scene.util.functools.partial.__init__
  • modo.item.scene.util.functools.partial.__new__
  • modo.item.scene.util.functools.partial.__reduce__
  • modo.item.scene.util.functools.partial.__reduce_ex__
  • modo.item.scene.util.functools.partial.__repr__
  • modo.item.scene.util.functools.partial.__setattr__
  • modo.item.scene.util.functools.partial.__setstate__
  • modo.item.scene.util.functools.partial.__sizeof__
  • modo.item.scene.util.functools.partial.__str__
  • modo.item.scene.util.functools.partial.__subclasshook__
  • modo.item.scene.util.functools.partial.args
  • modo.item.scene.util.functools.partial.func
  • modo.item.scene.util.functools.partial.keywords

modo.item.scene.util.functools.partial.args

type: member_descriptor

doc: tuple of arguments to future partial calls

modo.item.scene.util.functools.partial.func

type: member_descriptor

doc: function object to use in future partial calls

modo.item.scene.util.functools.partial.keywords

type: member_descriptor

doc: dictionary of keyword arguments to future partial calls

modo.item.scene.util.functools.reduce()

type: builtin_function_or_method

doc: reduce(function, sequence[, initial]) -> value Apply a function of two arguments cumulatively to the items of a sequence, from left to right, so as to reduce the sequence to a single value. For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates ((((1+2)+3)+4)+5). If initial is present, it is placed before the items of the sequence in the calculation, and serves as a default when the sequence is empty.

modo.item.scene.util.functools.total_ordering

type: function

doc: Class decorator that fills in missing ordering methods

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.item.scene.util.functools.update_wrapper

type: function

doc: Update a wrapper function to look like the wrapped function wrapper is the function to be updated wrapped is the original function assigned is a tuple naming the attributes assigned directly from the wrapped function to the wrapper function (defaults to functools.WRAPPER_ASSIGNMENTS) updated is a tuple naming the attributes of the wrapper that are updated with the corresponding attribute from the wrapped function (defaults to functools.WRAPPER_UPDATES)

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.item.scene.util.functools.WRAPPER_ASSIGNMENTS

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.scene.util.functools.WRAPPER_UPDATES

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.scene.util.functools.wraps

type: function

doc: Decorator factory to apply update_wrapper() to a wrapper function Returns a decorator that invokes update_wrapper() with the decorated function as the wrapper argument and the arguments to wraps() as the remaining arguments. Default arguments are as for update_wrapper(). This is a convenience function to simplify applying partial() to update_wrapper().

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.item.scene.util.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.scene.util.makeQuickCommand

type: function

doc: Quick way to create a command. Note that a command can only be blessed (registered) once per modo session, so this command will fail when attempting to rebless a command. :param string name: Name that the command will be callable by. Example: cmds.myCommand :param function func: The function that the command should call :param iterable arguments: A sequence of name:defaultvalue pairs to make arguments that will be passed on to the function :param basestring userName: The user name :param basestring description: Summary of the command's purpose :param basestring toolTip: Text that appears when hovering over the button example:: import modo def func_args(mystring, myint): print mystring, myint def func_simple(): print 'simple function, no arguments' modo.util.makeQuickCommand('test.simple', func_simple) modo.util.makeQuickCommand('test.args', func_args, (('mystring', 'mesh021'), ('myint', 23))) lx.eval('test.simple') lx.eval('test.args mesh022 24')

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.scene.util.paths

type: function

doc: Access to various system paths. :param basestring key: Specific path to return. Returns all if None. :returns dictionary or string: Dictionary containing all paths or single path as string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.scene.util.testGlobalInterpreter

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.scene.util.typeToFunc

type: function

doc: selects an item class constructor based on the item type passed as an argument and returns that as a class instantiation 'function' object to call the correct class in methods that eg select by item type or return items. In essence it acts as a sort of clearing house to try to ensure that any recognised but unwrapped items are wrapped with the correct modo.item.xxx type before being returned. example usage:: # get a list of all the light items in a scene where each light in the list is returned as the correctly # wrapped modo version of each light sub-type. import modo scene = modo.Scene() lights = [] for light in scene.ItemList(modo.c.LIGHT_TYPE): func = modo.c.typeToFunc(light.Type()) lights.append(func(light)) # or more succinctly as a list comprehension: lights = [modo.c.typeToFunc(light.Type())(light) for light in scene.ItemList(modo.c.LIGHT_TYPE)]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.SpotLight

type: type

doc: Spotlight item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Spotlight' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Spotlight item. :param light: Optional Spotlight item object (type lx.symbol.sITYPE_SPOTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Spotlight item selected. :raises TypeError: if the item passed as an argument isn't either a Spotlight item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight._item

type: property

modo.item.SpotLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.SpotLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.SpotLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.SpotLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.SpotLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.SpotLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.SpotLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.SpotLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.SpotLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.SpotLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.SpotLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.item.SpotLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.SpotLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.SpotLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.SpotLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.SpotLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.SpotLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.SpotLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.SpotLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.SpotLight.scene

type: property

modo.item.SpotLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.SpotLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.SpotLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.SpotLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.SpotLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.TextureLocator

type: type

doc: Texture locator item class. Takes an optional 'texloc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Texture locator' or an item name or ID to look up. If no texloc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param texloc: Optional texture locator item object (type lx.symbol.sITYPE_TEXTURELOC) or string (item name or ID) to look up. :type texloc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid texture locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'texture locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the texloc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator._item

type: property

modo.item.TextureLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.TextureLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.TextureLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.TextureLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.TextureLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.TextureLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.TextureLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.TextureLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.TextureLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.TextureLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.TextureLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.TextureLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.TextureLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.TextureLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.TextureLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.TextureLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.TextureLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.TextureLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.TextureLocator.scene

type: property

modo.item.TextureLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.TextureLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TextureLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.TextureLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.TextureLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.TransformItem

type: type

doc: Contains a group of animatable transform channels of a locator object. It has convenience functions for access of the locator's position, rotation and scale. examples:: # We retrieve two meshes from the current scene by name, assuming they exist cube = modo.Mesh('Cube') sphere = modo.Mesh('Sphere') # Set rotation values cube.rotation.set(10, 20, 30, degrees=True) # Link the position.x channel of the sphere to to the position.x channel of the cube cube.position.y.setLink(0, sphere.position.x, 0) # Set position values to zero cube.position.clear() # Insert keyframe for rotation on frame 21 frame = lx.service.Value().FrameToTime(21) cube.rotation.insertKey(time=frame)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem._item

type: property

modo.item.TransformItem._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem._TransformItem__rotationType

type: long

modo.item.TransformItem._TransformItem__scaleType

type: long

modo.item.TransformItem._TransformItem__toDegrees

type: function

doc: Utility function to consume and process the 'degrees' argument for the set function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem._TransformItem__transformType(self)

type: instancemethod

doc: Utility function that returns the corresponding string value from __types, for later channel lookup

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem._TransformItem__translationType

type: long
modo.item.TransformItem._TransformItem__types type: dict

modo.item.TransformItem._TransformItem__types.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.item.TransformItem._TransformItem__types.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.item.TransformItem._TransformItem__types.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.item.TransformItem._TransformItem__types.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.item.TransformItem._TransformItem__types.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.item.TransformItem._TransformItem__types.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.item.TransformItem._TransformItem__types.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.item.TransformItem._TransformItem__types.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.item.TransformItem._TransformItem__types.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.item.TransformItem._TransformItem__types.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.item.TransformItem._TransformItem__types.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.item.TransformItem._TransformItem__types.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.item.TransformItem._TransformItem__types.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.item.TransformItem._TransformItem__types.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.item.TransformItem._TransformItem__types.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.item.TransformItem._TransformItem__types.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.item.TransformItem._TransformItem__types.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.item.TransformItem._TransformItem__types.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.item.TransformItem.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.TransformItem.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.TransformItem.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.clear(self)

type: instancemethod

doc: Sets values to 1.0 if is a scaling transform and to 0.0 otherwise :param arguments: Same as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.TransformItem.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.TransformItem.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.get(self,time,action,degrees)

type: instancemethod

doc: Function to get the x, y and z-values of the locator at once. :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when getting rotation. :param keywords: Same as as :meth:`Channel.get` :returns tuple: x, y and z values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.TransformItem.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.TransformItem.insertKey(self,time,action)

type: instancemethod

doc: Inserts a keyframe on the respective x, y and z channels. :param float time: Time in seconds to create the new keys :param action: Action to create keys in.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.TransformItem.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.TransformItem.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.TransformItem.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.TransformItem.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.TransformItem.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.TransformItem.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.TransformItem.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.TransformItem.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.removeKey(self,time,action)

type: instancemethod

doc:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.scene

type: property

modo.item.TransformItem.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.TransformItem.set(self,values,time,key,action,degrees)

type: instancemethod

doc: Function to set the x, y and z-values of the locator at once. :param values: either three floats, or a list/tuple containing the x, y, z values to set :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when setting rotation. :param keywords: Same as as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItem.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.TransformItem.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.TransformItem.x

type: property

doc: Shortcut to the x channel of the locator :getter: :class:`Channel` :rtype: float

modo.item.TransformItem.y

type: property

doc: Shortcut to the y channel of the locator :getter: :class:`Channel` :rtype: float

modo.item.TransformItem.z

type: property

doc: Shortcut to the z channel of the locator :getter: :class:`Channel` :rtype: float

modo.item.TransformItems

type: type

doc: Container class for the stacked transform items of a Locator object. Transform items contain channels for either position, rotation or scale. The order of how they are processed can be changed and new transform items can be inserted or existing ones deleted. example:: scene = modo.scene.current() # Grab first selected object for item in scene.selected[:1]: # Print the amount of transform items print len(item.transforms) # Add a new position transform item position = item.transforms.insert('position', values=(1,0,0), name='New_Position') # Add a new scale transform item scale = item.transforms.insert('scale', values=(2,2,2), name='Scaled') # Swap the indices of the first two transform items item.transforms.reposition(0,1) # Delete item.transforms.delete(scale) # Clear values of all transforms for i in item.transforms: i.clear()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems._item

type: property

modo.item.TransformItems._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.item.TransformItems.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.item.TransformItems.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.item.TransformItems.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.item.TransformItems.delete(self,index)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.item.TransformItems.idNames(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.item.TransformItems.insert(self,xfrmType,placement,values,name)

type: instancemethod

doc: Insert a new transform item into the transform chain. The 'prepend' and 'append' placement values place the new item at the top or bottom of the stack, where 'pre' and 'post' place it around the respective transform highlighted in black in the channel view. I am myself confused about the order though, is it bottom to top or the other way around? Note that modo always keeps at least one of each type of transform, so when you attempt to delete it a new one is created automatically. :param string xfrmType: 'position', 'rotation' or 'scale' :param string placement: 'prepend', 'append', 'pre' or 'post' :param tuple values: Initial xyz values to be optionally set :param string name: Optional name

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.item.TransformItems.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.item.TransformItems.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.item.TransformItems.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.item.TransformItems.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.item.TransformItems.names(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.item.TransformItems.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.item.TransformItems.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.item.TransformItems.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.TransformItems.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.TransformItems.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.reposition(self,indexFrom,indexTo)

type: instancemethod

doc: Places a transform item to the provided index of the transform item stack :param int indexFrom: Source Index of the item that is to be moved :param int indexTo: Destination index to place item at

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.TransformItems.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.item.TransformItems.scene

type: property

modo.item.TransformItems.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.item.TransformItems.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.TransformItems.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.TransformItems.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.item.TransformItems.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.item.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.util.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.item.util.collections

type: module

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.item.util.collections._abcoll

type: module

doc: Abstract Base Classes (ABCs) for collections, according to PEP 3119. DON'T USE THIS MODULE DIRECTLY! The classes here should be imported via collections; they are defined here only to alleviate certain bootstrapping issues. Unit tests are in test_collections.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll._hasattr

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.item.util.collections._abcoll.ABCMeta

type: type

doc: Metaclass for defining Abstract Base Classes (ABCs). Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as 'virtual subclasses' -- these and their descendants will be considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won't show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via super()).

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\abc.pyc

    modo.item.util.collections._abcoll.ABCMeta contents:
  • modo.item.util.collections._abcoll.ABCMeta.__base__
  • modo.item.util.collections._abcoll.ABCMeta.__bases__
  • modo.item.util.collections._abcoll.ABCMeta.__basicsize__
  • modo.item.util.collections._abcoll.ABCMeta.__call__
  • modo.item.util.collections._abcoll.ABCMeta.__class__
  • modo.item.util.collections._abcoll.ABCMeta.__delattr__
  • modo.item.util.collections._abcoll.ABCMeta.__dict__
  • modo.item.util.collections._abcoll.ABCMeta.__dictoffset__
  • modo.item.util.collections._abcoll.ABCMeta.__doc__
  • modo.item.util.collections._abcoll.ABCMeta.__eq__
  • modo.item.util.collections._abcoll.ABCMeta.__flags__
  • modo.item.util.collections._abcoll.ABCMeta.__format__
  • modo.item.util.collections._abcoll.ABCMeta.__ge__
  • modo.item.util.collections._abcoll.ABCMeta.__getattribute__
  • modo.item.util.collections._abcoll.ABCMeta.__gt__
  • modo.item.util.collections._abcoll.ABCMeta.__hash__
  • modo.item.util.collections._abcoll.ABCMeta.__init__
  • modo.item.util.collections._abcoll.ABCMeta.__instancecheck__
  • modo.item.util.collections._abcoll.ABCMeta.__itemsize__
  • modo.item.util.collections._abcoll.ABCMeta.__le__
  • modo.item.util.collections._abcoll.ABCMeta.__lt__
  • modo.item.util.collections._abcoll.ABCMeta.__module__
  • modo.item.util.collections._abcoll.ABCMeta.__mro__
  • modo.item.util.collections._abcoll.ABCMeta.__name__
  • modo.item.util.collections._abcoll.ABCMeta.__ne__
  • modo.item.util.collections._abcoll.ABCMeta.__new__
  • modo.item.util.collections._abcoll.ABCMeta.__reduce__
  • modo.item.util.collections._abcoll.ABCMeta.__reduce_ex__
  • modo.item.util.collections._abcoll.ABCMeta.__repr__
  • modo.item.util.collections._abcoll.ABCMeta.__setattr__
  • modo.item.util.collections._abcoll.ABCMeta.__sizeof__
  • modo.item.util.collections._abcoll.ABCMeta.__str__
  • modo.item.util.collections._abcoll.ABCMeta.__subclasscheck__
  • modo.item.util.collections._abcoll.ABCMeta.__subclasses__
  • modo.item.util.collections._abcoll.ABCMeta.__subclasshook__
  • modo.item.util.collections._abcoll.ABCMeta.__weakrefoffset__
  • modo.item.util.collections._abcoll.ABCMeta._abc_invalidation_counter
  • modo.item.util.collections._abcoll.ABCMeta._dump_registry
  • modo.item.util.collections._abcoll.ABCMeta.mro
  • modo.item.util.collections._abcoll.ABCMeta.register

modo.item.util.collections._abcoll.ABCMeta._abc_invalidation_counter

type: int

modo.item.util.collections._abcoll.ABCMeta._dump_registry(cls,file)

type: instancemethod

doc: Debug helper to print the ABC registry.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.item.util.collections._abcoll.ABCMeta.mro()

type: method_descriptor

doc: mro() -> list return a type's method resolution order

modo.item.util.collections._abcoll.ABCMeta.register(cls,subclass)

type: instancemethod

doc: Register a virtual subclass of an ABC.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.item.util.collections._abcoll.abstractmethod

type: function

doc: A decorator indicating abstract methods. Requires that the metaclass is ABCMeta or derived from it. A class that has a metaclass derived from ABCMeta cannot be instantiated unless all of its abstract methods are overridden. The abstract methods can be called using any of the normal 'super' call mechanisms. Usage: class C: __metaclass__ = ABCMeta @abstractmethod def my_abstract_method(self, ...): ...

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.item.util.collections._abcoll.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._abcoll.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.item.util.collections._abcoll.sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.item.util.collections._abcoll.sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.item.util.collections._abcoll.sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.item.util.collections._abcoll.sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.util.collections._abcoll.sys.api_version

type: int

modo.item.util.collections._abcoll.sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.util.collections._abcoll.sys.byteorder

type: str

modo.item.util.collections._abcoll.sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.item.util.collections._abcoll.sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.item.util.collections._abcoll.sys.copyright

type: str

modo.item.util.collections._abcoll.sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.item.util.collections._abcoll.sys.dllhandle

type: long

modo.item.util.collections._abcoll.sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.item.util.collections._abcoll.sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.item.util.collections._abcoll.sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.item.util.collections._abcoll.sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.item.util.collections._abcoll.sys.exc_type

type: type

doc: Inappropriate argument type.

modo.item.util.collections._abcoll.sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.item.util.collections._abcoll.sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.item.util.collections._abcoll.sys.exec_prefix

type: str

modo.item.util.collections._abcoll.sys.executable

type: str

modo.item.util.collections._abcoll.sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.item.util.collections._abcoll.sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.item.util.collections._abcoll.sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.item.util.collections._abcoll.sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.item.util.collections._abcoll.sys.float_repr_style

type: str

modo.item.util.collections._abcoll.sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.item.util.collections._abcoll.sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.item.util.collections._abcoll.sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.item.util.collections._abcoll.sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.item.util.collections._abcoll.sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.item.util.collections._abcoll.sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.item.util.collections._abcoll.sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.item.util.collections._abcoll.sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.item.util.collections._abcoll.sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.item.util.collections._abcoll.sys.hexversion

type: int

modo.item.util.collections._abcoll.sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.item.util.collections._abcoll.sys.maxint

type: int

modo.item.util.collections._abcoll.sys.maxsize

type: long

modo.item.util.collections._abcoll.sys.maxunicode

type: int

modo.item.util.collections._abcoll.sys.meta_path

type: list

modo.item.util.collections._abcoll.sys.modules

type: dict

modo.item.util.collections._abcoll.sys.path

type: list

modo.item.util.collections._abcoll.sys.path_hooks

type: list

modo.item.util.collections._abcoll.sys.path_importer_cache

type: dict

modo.item.util.collections._abcoll.sys.platform

type: str

modo.item.util.collections._abcoll.sys.prefix

type: str

modo.item.util.collections._abcoll.sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.item.util.collections._abcoll.sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.item.util.collections._abcoll.sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.item.util.collections._abcoll.sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.item.util.collections._abcoll.sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.item.util.collections._abcoll.sys.stderr

type: SESysStdErr

modo.item.util.collections._abcoll.sys.stdin

type: SESysStdIn

modo.item.util.collections._abcoll.sys.stdout

type: SESysStdOut

modo.item.util.collections._abcoll.sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.util.collections._abcoll.sys.version

type: str

modo.item.util.collections._abcoll.sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.item.util.collections._abcoll.sys.warnoptions

type: list

modo.item.util.collections._abcoll.sys.winver

type: str

modo.item.util.collections._abcoll.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections._chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.item.util.collections._chain contents:
  • modo.item.util.collections._chain.__class__
  • modo.item.util.collections._chain.__delattr__
  • modo.item.util.collections._chain.__doc__
  • modo.item.util.collections._chain.__format__
  • modo.item.util.collections._chain.__getattribute__
  • modo.item.util.collections._chain.__hash__
  • modo.item.util.collections._chain.__init__
  • modo.item.util.collections._chain.__iter__
  • modo.item.util.collections._chain.__new__
  • modo.item.util.collections._chain.__reduce__
  • modo.item.util.collections._chain.__reduce_ex__
  • modo.item.util.collections._chain.__repr__
  • modo.item.util.collections._chain.__setattr__
  • modo.item.util.collections._chain.__sizeof__
  • modo.item.util.collections._chain.__str__
  • modo.item.util.collections._chain.__subclasshook__
  • modo.item.util.collections._chain.from_iterable
  • modo.item.util.collections._chain.next

modo.item.util.collections._chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.item.util.collections._chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.item.util.collections._get_ident()

type: builtin_function_or_method

doc: get_ident() -> integer Return a non-zero integer that uniquely identifies the current thread amongst other threads that exist simultaneously. This may be used to identify per-thread resources. Even though on some platforms threads identities may appear to be allocated consecutive numbers starting at 1, this behavior should not be relied upon, and the number should be seen purely as a magic cookie. A thread's identity may be reused for another thread after it exits.

modo.item.util.collections._heapq

type: module

doc: Heap queue algorithm (a.k.a. priority queue). Heaps are arrays for which a[k] <= a[2*k+1] and a[k] <= a[2*k+2] for all k, counting elements from 0. For the sake of comparison, non-existing elements are considered to be infinite. The interesting property of a heap is that a[0] is always its smallest element. Usage: heap = [] # creates an empty heap heappush(heap, item) # pushes a new item on the heap item = heappop(heap) # pops the smallest item from the heap item = heap[0] # smallest item on the heap without popping it heapify(x) # transforms list into a heap, in-place, in linear time item = heapreplace(heap, item) # pops and returns smallest item, and adds # new item; the heap size is unchanged Our API differs from textbook heap algorithms as follows: - We use 0-based indexing. This makes the relationship between the index for a node and the indexes for its children slightly less obvious, but is more suitable since Python uses 0-based indexing. - Our heappop() method returns the smallest item, not the largest. These two make it possible to view the heap as a regular Python list without surprises: heap[0] is the smallest item, and heap.sort() maintains the heap invariant!

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\heapq.pyc

modo.item.util.collections._heapq._nlargest()

type: builtin_function_or_method

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, reverse=True)[:n]

modo.item.util.collections._heapq._nsmallest()

type: builtin_function_or_method

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable)[:n]

modo.item.util.collections._heapq._siftdown

type: function

file: .\Lib\heapq.py

modo.item.util.collections._heapq._siftup

type: function

file: .\Lib\heapq.py

modo.item.util.collections._heapq.bisect

type: module

doc: Bisection algorithms.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\bisect.pyc

modo.item.util.collections._heapq.bisect.bisect()

type: builtin_function_or_method

doc: Alias for bisect_right().

modo.item.util.collections._heapq.bisect.bisect_left()

type: builtin_function_or_method

doc: bisect_left(a, x[, lo[, hi]]) -> index Return the index where to insert item x in list a, assuming a is sorted. The return value i is such that all e in a[:i] have e < x, and all e in a[i:] have e >= x. So if x already appears in the list, i points just before the leftmost x already there. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.item.util.collections._heapq.bisect.bisect_right()

type: builtin_function_or_method

doc: bisect_right(a, x[, lo[, hi]]) -> index Return the index where to insert item x in list a, assuming a is sorted. The return value i is such that all e in a[:i] have e <= x, and all e in a[i:] have e > x. So if x already appears in the list, i points just beyond the rightmost x already there Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.item.util.collections._heapq.bisect.insort()

type: builtin_function_or_method

doc: Alias for insort_right().

modo.item.util.collections._heapq.bisect.insort_left()

type: builtin_function_or_method

doc: insort_left(a, x[, lo[, hi]]) Insert item x in list a, and keep it sorted assuming a is sorted. If x is already in a, insert it to the left of the leftmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.item.util.collections._heapq.bisect.insort_right()

type: builtin_function_or_method

doc: insort_right(a, x[, lo[, hi]]) Insert item x in list a, and keep it sorted assuming a is sorted. If x is already in a, insert it to the right of the rightmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.item.util.collections._heapq.chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.item.util.collections._heapq.chain contents:
  • modo.item.util.collections._heapq.chain.__class__
  • modo.item.util.collections._heapq.chain.__delattr__
  • modo.item.util.collections._heapq.chain.__doc__
  • modo.item.util.collections._heapq.chain.__format__
  • modo.item.util.collections._heapq.chain.__getattribute__
  • modo.item.util.collections._heapq.chain.__hash__
  • modo.item.util.collections._heapq.chain.__init__
  • modo.item.util.collections._heapq.chain.__iter__
  • modo.item.util.collections._heapq.chain.__new__
  • modo.item.util.collections._heapq.chain.__reduce__
  • modo.item.util.collections._heapq.chain.__reduce_ex__
  • modo.item.util.collections._heapq.chain.__repr__
  • modo.item.util.collections._heapq.chain.__setattr__
  • modo.item.util.collections._heapq.chain.__sizeof__
  • modo.item.util.collections._heapq.chain.__str__
  • modo.item.util.collections._heapq.chain.__subclasshook__
  • modo.item.util.collections._heapq.chain.from_iterable
  • modo.item.util.collections._heapq.chain.next

modo.item.util.collections._heapq.chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.item.util.collections._heapq.chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.item.util.collections._heapq.cmp_lt

type: function

file: .\Lib\heapq.py

modo.item.util.collections._heapq.count

type: type

doc: count(start=0, step=1) --> count object Return a count object whose .next() method returns consecutive values. Equivalent to: def count(firstval=0, step=1): x = firstval while 1: yield x x += step

    modo.item.util.collections._heapq.count contents:
  • modo.item.util.collections._heapq.count.__class__
  • modo.item.util.collections._heapq.count.__delattr__
  • modo.item.util.collections._heapq.count.__doc__
  • modo.item.util.collections._heapq.count.__format__
  • modo.item.util.collections._heapq.count.__getattribute__
  • modo.item.util.collections._heapq.count.__hash__
  • modo.item.util.collections._heapq.count.__init__
  • modo.item.util.collections._heapq.count.__iter__
  • modo.item.util.collections._heapq.count.__new__
  • modo.item.util.collections._heapq.count.__reduce__
  • modo.item.util.collections._heapq.count.__reduce_ex__
  • modo.item.util.collections._heapq.count.__repr__
  • modo.item.util.collections._heapq.count.__setattr__
  • modo.item.util.collections._heapq.count.__sizeof__
  • modo.item.util.collections._heapq.count.__str__
  • modo.item.util.collections._heapq.count.__subclasshook__
  • modo.item.util.collections._heapq.count.next

modo.item.util.collections._heapq.count.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.item.util.collections._heapq.heapify()

type: builtin_function_or_method

doc: Transform list into a heap, in-place, in O(len(heap)) time.

modo.item.util.collections._heapq.heappop()

type: builtin_function_or_method

doc: Pop the smallest item off the heap, maintaining the heap invariant.

modo.item.util.collections._heapq.heappush()

type: builtin_function_or_method

doc: Push item onto heap, maintaining the heap invariant.

modo.item.util.collections._heapq.heappushpop()

type: builtin_function_or_method

doc: Push item on the heap, then pop and return the smallest item from the heap. The combined action runs more efficiently than heappush() followed by a separate call to heappop().

modo.item.util.collections._heapq.heapreplace()

type: builtin_function_or_method

doc: Pop and return the current smallest value, and add the new item. This is more efficient than heappop() followed by heappush(), and can be more appropriate when using a fixed-size heap. Note that the value returned may be larger than item! That constrains reasonable uses of this routine unless written as part of a conditional replacement: if item > heap[0]: item = heapreplace(heap, item)

modo.item.util.collections._heapq.imap

type: type

doc: imap(func, *iterables) --> imap object Make an iterator that computes the function using arguments from each of the iterables. Like map() except that it returns an iterator instead of a list and that it stops when the shortest iterable is exhausted instead of filling in None for shorter iterables.

    modo.item.util.collections._heapq.imap contents:
  • modo.item.util.collections._heapq.imap.__class__
  • modo.item.util.collections._heapq.imap.__delattr__
  • modo.item.util.collections._heapq.imap.__doc__
  • modo.item.util.collections._heapq.imap.__format__
  • modo.item.util.collections._heapq.imap.__getattribute__
  • modo.item.util.collections._heapq.imap.__hash__
  • modo.item.util.collections._heapq.imap.__init__
  • modo.item.util.collections._heapq.imap.__iter__
  • modo.item.util.collections._heapq.imap.__new__
  • modo.item.util.collections._heapq.imap.__reduce__
  • modo.item.util.collections._heapq.imap.__reduce_ex__
  • modo.item.util.collections._heapq.imap.__repr__
  • modo.item.util.collections._heapq.imap.__setattr__
  • modo.item.util.collections._heapq.imap.__sizeof__
  • modo.item.util.collections._heapq.imap.__str__
  • modo.item.util.collections._heapq.imap.__subclasshook__
  • modo.item.util.collections._heapq.imap.next

modo.item.util.collections._heapq.imap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.item.util.collections._heapq.islice

type: type

doc: islice(iterable, [start,] stop [, step]) --> islice object Return an iterator whose next() method returns selected values from an iterable. If start is specified, will skip all preceding elements; otherwise, start defaults to zero. Step defaults to one. If specified as another value, step determines how many values are skipped between successive calls. Works like a slice() on a list but returns an iterator.

    modo.item.util.collections._heapq.islice contents:
  • modo.item.util.collections._heapq.islice.__class__
  • modo.item.util.collections._heapq.islice.__delattr__
  • modo.item.util.collections._heapq.islice.__doc__
  • modo.item.util.collections._heapq.islice.__format__
  • modo.item.util.collections._heapq.islice.__getattribute__
  • modo.item.util.collections._heapq.islice.__hash__
  • modo.item.util.collections._heapq.islice.__init__
  • modo.item.util.collections._heapq.islice.__iter__
  • modo.item.util.collections._heapq.islice.__new__
  • modo.item.util.collections._heapq.islice.__reduce__
  • modo.item.util.collections._heapq.islice.__reduce_ex__
  • modo.item.util.collections._heapq.islice.__repr__
  • modo.item.util.collections._heapq.islice.__setattr__
  • modo.item.util.collections._heapq.islice.__sizeof__
  • modo.item.util.collections._heapq.islice.__str__
  • modo.item.util.collections._heapq.islice.__subclasshook__
  • modo.item.util.collections._heapq.islice.next

modo.item.util.collections._heapq.islice.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.item.util.collections._heapq.itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.item.util.collections._heapq.itemgetter contents:
  • modo.item.util.collections._heapq.itemgetter.__call__
  • modo.item.util.collections._heapq.itemgetter.__class__
  • modo.item.util.collections._heapq.itemgetter.__delattr__
  • modo.item.util.collections._heapq.itemgetter.__doc__
  • modo.item.util.collections._heapq.itemgetter.__format__
  • modo.item.util.collections._heapq.itemgetter.__getattribute__
  • modo.item.util.collections._heapq.itemgetter.__hash__
  • modo.item.util.collections._heapq.itemgetter.__init__
  • modo.item.util.collections._heapq.itemgetter.__new__
  • modo.item.util.collections._heapq.itemgetter.__reduce__
  • modo.item.util.collections._heapq.itemgetter.__reduce_ex__
  • modo.item.util.collections._heapq.itemgetter.__repr__
  • modo.item.util.collections._heapq.itemgetter.__setattr__
  • modo.item.util.collections._heapq.itemgetter.__sizeof__
  • modo.item.util.collections._heapq.itemgetter.__str__
  • modo.item.util.collections._heapq.itemgetter.__subclasshook__
modo.item.util.collections._heapq.izip

type: type

doc: izip(iter1 [,iter2 [...]]) --> izip object Return a izip object whose .next() method returns a tuple where the i-th element comes from the i-th iterable argument. The .next() method continues until the shortest iterable in the argument sequence is exhausted and then it raises StopIteration. Works like the zip() function but consumes less memory by returning an iterator instead of a list.

    modo.item.util.collections._heapq.izip contents:
  • modo.item.util.collections._heapq.izip.__class__
  • modo.item.util.collections._heapq.izip.__delattr__
  • modo.item.util.collections._heapq.izip.__doc__
  • modo.item.util.collections._heapq.izip.__format__
  • modo.item.util.collections._heapq.izip.__getattribute__
  • modo.item.util.collections._heapq.izip.__hash__
  • modo.item.util.collections._heapq.izip.__init__
  • modo.item.util.collections._heapq.izip.__iter__
  • modo.item.util.collections._heapq.izip.__new__
  • modo.item.util.collections._heapq.izip.__reduce__
  • modo.item.util.collections._heapq.izip.__reduce_ex__
  • modo.item.util.collections._heapq.izip.__repr__
  • modo.item.util.collections._heapq.izip.__setattr__
  • modo.item.util.collections._heapq.izip.__sizeof__
  • modo.item.util.collections._heapq.izip.__str__
  • modo.item.util.collections._heapq.izip.__subclasshook__
  • modo.item.util.collections._heapq.izip.next

modo.item.util.collections._heapq.izip.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.item.util.collections._heapq.merge

type: function

doc: Merge multiple sorted inputs into a single sorted output. Similar to sorted(itertools.chain(*iterables)) but returns a generator, does not pull the data into memory all at once, and assumes that each of the input streams is already sorted (smallest to largest). >>> list(merge([1,3,5,7], [0,2,4,8], [5,10,15,20], [], [25])) [0, 1, 2, 3, 4, 5, 5, 7, 8, 10, 15, 20, 25]

file: .\Lib\heapq.py

modo.item.util.collections._heapq.nlargest

type: function

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, key=key, reverse=True)[:n]

file: .\Lib\heapq.py

modo.item.util.collections._heapq.nsmallest

type: function

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable, key=key)[:n]

file: .\Lib\heapq.py

modo.item.util.collections._heapq.repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.item.util.collections._heapq.repeat contents:
  • modo.item.util.collections._heapq.repeat.__class__
  • modo.item.util.collections._heapq.repeat.__delattr__
  • modo.item.util.collections._heapq.repeat.__doc__
  • modo.item.util.collections._heapq.repeat.__format__
  • modo.item.util.collections._heapq.repeat.__getattribute__
  • modo.item.util.collections._heapq.repeat.__hash__
  • modo.item.util.collections._heapq.repeat.__init__
  • modo.item.util.collections._heapq.repeat.__iter__
  • modo.item.util.collections._heapq.repeat.__length_hint__
  • modo.item.util.collections._heapq.repeat.__new__
  • modo.item.util.collections._heapq.repeat.__reduce__
  • modo.item.util.collections._heapq.repeat.__reduce_ex__
  • modo.item.util.collections._heapq.repeat.__repr__
  • modo.item.util.collections._heapq.repeat.__setattr__
  • modo.item.util.collections._heapq.repeat.__sizeof__
  • modo.item.util.collections._heapq.repeat.__str__
  • modo.item.util.collections._heapq.repeat.__subclasshook__
  • modo.item.util.collections._heapq.repeat.next

modo.item.util.collections._heapq.repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.item.util.collections._heapq.tee()

type: builtin_function_or_method

doc: tee(iterable, n=2) --> tuple of n independent iterators.

modo.item.util.collections._iskeyword()

type: builtin_function_or_method

doc: x.__contains__(y) <==> y in x.

modo.item.util.collections._itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.item.util.collections._itemgetter contents:
  • modo.item.util.collections._itemgetter.__call__
  • modo.item.util.collections._itemgetter.__class__
  • modo.item.util.collections._itemgetter.__delattr__
  • modo.item.util.collections._itemgetter.__doc__
  • modo.item.util.collections._itemgetter.__format__
  • modo.item.util.collections._itemgetter.__getattribute__
  • modo.item.util.collections._itemgetter.__hash__
  • modo.item.util.collections._itemgetter.__init__
  • modo.item.util.collections._itemgetter.__new__
  • modo.item.util.collections._itemgetter.__reduce__
  • modo.item.util.collections._itemgetter.__reduce_ex__
  • modo.item.util.collections._itemgetter.__repr__
  • modo.item.util.collections._itemgetter.__setattr__
  • modo.item.util.collections._itemgetter.__sizeof__
  • modo.item.util.collections._itemgetter.__str__
  • modo.item.util.collections._itemgetter.__subclasshook__
modo.item.util.collections._repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.item.util.collections._repeat contents:
  • modo.item.util.collections._repeat.__class__
  • modo.item.util.collections._repeat.__delattr__
  • modo.item.util.collections._repeat.__doc__
  • modo.item.util.collections._repeat.__format__
  • modo.item.util.collections._repeat.__getattribute__
  • modo.item.util.collections._repeat.__hash__
  • modo.item.util.collections._repeat.__init__
  • modo.item.util.collections._repeat.__iter__
  • modo.item.util.collections._repeat.__length_hint__
  • modo.item.util.collections._repeat.__new__
  • modo.item.util.collections._repeat.__reduce__
  • modo.item.util.collections._repeat.__reduce_ex__
  • modo.item.util.collections._repeat.__repr__
  • modo.item.util.collections._repeat.__setattr__
  • modo.item.util.collections._repeat.__sizeof__
  • modo.item.util.collections._repeat.__str__
  • modo.item.util.collections._repeat.__subclasshook__
  • modo.item.util.collections._repeat.next

modo.item.util.collections._repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.item.util.collections._starmap

type: type

doc: starmap(function, sequence) --> starmap object Return an iterator whose values are returned from the function evaluated with a argument tuple taken from the given sequence.

    modo.item.util.collections._starmap contents:
  • modo.item.util.collections._starmap.__class__
  • modo.item.util.collections._starmap.__delattr__
  • modo.item.util.collections._starmap.__doc__
  • modo.item.util.collections._starmap.__format__
  • modo.item.util.collections._starmap.__getattribute__
  • modo.item.util.collections._starmap.__hash__
  • modo.item.util.collections._starmap.__init__
  • modo.item.util.collections._starmap.__iter__
  • modo.item.util.collections._starmap.__new__
  • modo.item.util.collections._starmap.__reduce__
  • modo.item.util.collections._starmap.__reduce_ex__
  • modo.item.util.collections._starmap.__repr__
  • modo.item.util.collections._starmap.__setattr__
  • modo.item.util.collections._starmap.__sizeof__
  • modo.item.util.collections._starmap.__str__
  • modo.item.util.collections._starmap.__subclasshook__
  • modo.item.util.collections._starmap.next

modo.item.util.collections._starmap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.item.util.collections._sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.item.util.collections._sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.item.util.collections._sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.item.util.collections._sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.item.util.collections._sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.util.collections._sys.api_version

type: int

modo.item.util.collections._sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.util.collections._sys.byteorder

type: str

modo.item.util.collections._sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.item.util.collections._sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.item.util.collections._sys.copyright

type: str

modo.item.util.collections._sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.item.util.collections._sys.dllhandle

type: long

modo.item.util.collections._sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.item.util.collections._sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.item.util.collections._sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.item.util.collections._sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.item.util.collections._sys.exc_type

type: type

doc: Inappropriate argument type.

    modo.item.util.collections._sys.exc_type contents:
  • modo.item.util.collections._sys.exc_type.__class__
  • modo.item.util.collections._sys.exc_type.__delattr__
  • modo.item.util.collections._sys.exc_type.__dict__
  • modo.item.util.collections._sys.exc_type.__doc__
  • modo.item.util.collections._sys.exc_type.__format__
  • modo.item.util.collections._sys.exc_type.__getattribute__
  • modo.item.util.collections._sys.exc_type.__getitem__
  • modo.item.util.collections._sys.exc_type.__getslice__
  • modo.item.util.collections._sys.exc_type.__hash__
  • modo.item.util.collections._sys.exc_type.__init__
  • modo.item.util.collections._sys.exc_type.__new__
  • modo.item.util.collections._sys.exc_type.__reduce__
  • modo.item.util.collections._sys.exc_type.__reduce_ex__
  • modo.item.util.collections._sys.exc_type.__repr__
  • modo.item.util.collections._sys.exc_type.__setattr__
  • modo.item.util.collections._sys.exc_type.__setstate__
  • modo.item.util.collections._sys.exc_type.__sizeof__
  • modo.item.util.collections._sys.exc_type.__str__
  • modo.item.util.collections._sys.exc_type.__subclasshook__
  • modo.item.util.collections._sys.exc_type.__unicode__
  • modo.item.util.collections._sys.exc_type.args
  • modo.item.util.collections._sys.exc_type.message

modo.item.util.collections._sys.exc_type.args

type: getset_descriptor

modo.item.util.collections._sys.exc_type.message

type: getset_descriptor

modo.item.util.collections._sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.item.util.collections._sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.item.util.collections._sys.exec_prefix

type: str

modo.item.util.collections._sys.executable

type: str

modo.item.util.collections._sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.item.util.collections._sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.item.util.collections._sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.item.util.collections._sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.item.util.collections._sys.float_repr_style

type: str

modo.item.util.collections._sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.item.util.collections._sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.item.util.collections._sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.item.util.collections._sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.item.util.collections._sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.item.util.collections._sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.item.util.collections._sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.item.util.collections._sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.item.util.collections._sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.item.util.collections._sys.hexversion

type: int

modo.item.util.collections._sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.item.util.collections._sys.maxint

type: int

modo.item.util.collections._sys.maxsize

type: long

modo.item.util.collections._sys.maxunicode

type: int

modo.item.util.collections._sys.meta_path

type: list
modo.item.util.collections._sys.modules type: dict

modo.item.util.collections._sys.modules.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.item.util.collections._sys.modules.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.item.util.collections._sys.modules.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.item.util.collections._sys.modules.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.item.util.collections._sys.modules.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.item.util.collections._sys.modules.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.item.util.collections._sys.modules.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.item.util.collections._sys.modules.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.item.util.collections._sys.modules.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.item.util.collections._sys.modules.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.item.util.collections._sys.modules.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.item.util.collections._sys.modules.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.item.util.collections._sys.modules.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.item.util.collections._sys.modules.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.item.util.collections._sys.modules.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.item.util.collections._sys.modules.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.item.util.collections._sys.modules.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.item.util.collections._sys.modules.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.item.util.collections._sys.path

type: list

modo.item.util.collections._sys.path_hooks

type: list
modo.item.util.collections._sys.path_importer_cache type: dict

modo.item.util.collections._sys.path_importer_cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.item.util.collections._sys.path_importer_cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.item.util.collections._sys.path_importer_cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.item.util.collections._sys.path_importer_cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.item.util.collections._sys.path_importer_cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.item.util.collections._sys.path_importer_cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.item.util.collections._sys.path_importer_cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.item.util.collections._sys.path_importer_cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.item.util.collections._sys.path_importer_cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.item.util.collections._sys.path_importer_cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.item.util.collections._sys.path_importer_cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.item.util.collections._sys.path_importer_cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.item.util.collections._sys.path_importer_cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.item.util.collections._sys.path_importer_cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.item.util.collections._sys.path_importer_cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.item.util.collections._sys.path_importer_cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.item.util.collections._sys.path_importer_cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.item.util.collections._sys.path_importer_cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.item.util.collections._sys.platform

type: str

modo.item.util.collections._sys.prefix

type: str

modo.item.util.collections._sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.item.util.collections._sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.item.util.collections._sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.item.util.collections._sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.item.util.collections._sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.item.util.collections._sys.stderr

type: SESysStdErr

modo.item.util.collections._sys.stdin

type: SESysStdIn

modo.item.util.collections._sys.stdout

type: SESysStdOut

modo.item.util.collections._sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.util.collections._sys.version

type: str

modo.item.util.collections._sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.item.util.collections._sys.warnoptions

type: list

modo.item.util.collections._sys.winver

type: str

modo.item.util.collections.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.Counter

type: type

doc: Dict subclass for counting hashable items. Sometimes called a bag or multiset. Elements are stored as dictionary keys and their counts are stored as dictionary values. >>> c = Counter('abcdeabcdabcaba') # count elements from a string >>> c.most_common(3) # three most common elements [('a', 5), ('b', 4), ('c', 3)] >>> sorted(c) # list all unique elements ['a', 'b', 'c', 'd', 'e'] >>> ''.join(sorted(c.elements())) # list elements with repetitions 'aaaaabbbbcccdde' >>> sum(c.values()) # total of all counts 15 >>> c['a'] # count of letter 'a' 5 >>> for elem in 'shazam': # update counts from an iterable ... c[elem] += 1 # by adding 1 to each element's count >>> c['a'] # now there are seven 'a' 7 >>> del c['b'] # remove all 'b' >>> c['b'] # now there are zero 'b' 0 >>> d = Counter('simsalabim') # make another counter >>> c.update(d) # add in the second counter >>> c['a'] # now there are nine 'a' 9 >>> c.clear() # empty the counter >>> c Counter() Note: If a count is set to zero or reduced to zero, it will remain in the counter until the entry is deleted or the counter is cleared: >>> c = Counter('aaabbc') >>> c['b'] -= 2 # reduce the count of 'b' by two >>> c.most_common() # 'b' is still in, but its count is zero [('a', 3), ('c', 1), ('b', 0)]

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.item.util.collections.Counter.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.item.util.collections.Counter.copy(self)

type: instancemethod

doc: Return a shallow copy.

file: .\Lib\collections.py

modo.item.util.collections.Counter.elements(self)

type: instancemethod

doc: Iterator over elements repeating each as many times as its count. >>> c = Counter('ABCABC') >>> sorted(c.elements()) ['A', 'A', 'B', 'B', 'C', 'C'] # Knuth's example for prime factors of 1836: 2**2 * 3**3 * 17**1 >>> prime_factors = Counter({2: 2, 3: 3, 17: 1}) >>> product = 1 >>> for factor in prime_factors.elements(): # loop over factors ... product *= factor # and multiply them >>> product 1836 Note, if an element's count has been set to zero or is a negative number, elements() will ignore it.

file: .\Lib\collections.py

modo.item.util.collections.Counter.fromkeys(cls,iterable,v)

type: instancemethod

file: .\Lib\collections.py

modo.item.util.collections.Counter.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.item.util.collections.Counter.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.item.util.collections.Counter.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.item.util.collections.Counter.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.item.util.collections.Counter.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.item.util.collections.Counter.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.item.util.collections.Counter.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.item.util.collections.Counter.most_common(self,n)

type: instancemethod

doc: List the n most common elements and their counts from the most common to the least. If n is None, then list all element counts. >>> Counter('abcdeabcdabcaba').most_common(3) [('a', 5), ('b', 4), ('c', 3)]

file: .\Lib\collections.py

modo.item.util.collections.Counter.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.item.util.collections.Counter.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.item.util.collections.Counter.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.item.util.collections.Counter.subtract(self,iterable)

type: instancemethod

doc: Like dict.update() but subtracts counts instead of replacing them. Counts can be reduced below zero. Both the inputs and outputs are allowed to contain zero and negative counts. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.subtract('witch') # subtract elements from another iterable >>> c.subtract(Counter('watch')) # subtract elements from another counter >>> c['h'] # 2 in which, minus 1 in witch, minus 1 in watch 0 >>> c['w'] # 1 in which, minus 1 in witch, minus 1 in watch -1

file: .\Lib\collections.py

modo.item.util.collections.Counter.update(self,iterable)

type: instancemethod

doc: Like dict.update() but add counts instead of replacing them. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.update('witch') # add elements from another iterable >>> d = Counter('watch') >>> c.update(d) # add elements from another counter >>> c['h'] # four 'h' in which, witch, and watch 4

file: .\Lib\collections.py

modo.item.util.collections.Counter.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.item.util.collections.Counter.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.item.util.collections.Counter.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.item.util.collections.Counter.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.item.util.collections.defaultdict

type: type

doc: defaultdict(default_factory) --> dict with default factory The default factory is called without arguments to produce a new value when a key is not present, in __getitem__ only. A defaultdict compares equal to a dict with the same items.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.item.util.collections.defaultdict.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.item.util.collections.defaultdict.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D.

modo.item.util.collections.defaultdict.default_factory

type: member_descriptor

doc: Factory for default value called by __missing__().

modo.item.util.collections.defaultdict.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.item.util.collections.defaultdict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.item.util.collections.defaultdict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.item.util.collections.defaultdict.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.item.util.collections.defaultdict.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.item.util.collections.defaultdict.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.item.util.collections.defaultdict.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.item.util.collections.defaultdict.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.item.util.collections.defaultdict.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.item.util.collections.defaultdict.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.item.util.collections.defaultdict.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.item.util.collections.defaultdict.update()

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.item.util.collections.defaultdict.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.item.util.collections.defaultdict.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.item.util.collections.defaultdict.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.item.util.collections.defaultdict.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.item.util.collections.deque

type: type

doc: deque(iterable[, maxlen]) --> deque object Build an ordered collection with optimized access from its endpoints.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.item.util.collections.deque.append()

type: method_descriptor

doc: Add an element to the right side of the deque.

modo.item.util.collections.deque.appendleft()

type: method_descriptor

doc: Add an element to the left side of the deque.

modo.item.util.collections.deque.clear()

type: method_descriptor

doc: Remove all elements from the deque.

modo.item.util.collections.deque.count()

type: method_descriptor

doc: D.count(value) -> integer -- return number of occurrences of value

modo.item.util.collections.deque.extend()

type: method_descriptor

doc: Extend the right side of the deque with elements from the iterable

modo.item.util.collections.deque.extendleft()

type: method_descriptor

doc: Extend the left side of the deque with elements from the iterable

modo.item.util.collections.deque.maxlen

type: getset_descriptor

doc: maximum size of a deque or None if unbounded

modo.item.util.collections.deque.pop()

type: method_descriptor

doc: Remove and return the rightmost element.

modo.item.util.collections.deque.popleft()

type: method_descriptor

doc: Remove and return the leftmost element.

modo.item.util.collections.deque.remove()

type: method_descriptor

doc: D.remove(value) -- remove first occurrence of value.

modo.item.util.collections.deque.reverse()

type: method_descriptor

doc: D.reverse() -- reverse *IN PLACE*

modo.item.util.collections.deque.rotate()

type: method_descriptor

doc: Rotate the deque n steps to the right (default n=1). If n is negative, rotates left.

modo.item.util.collections.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.namedtuple

type: function

doc: Returns a new subclass of tuple with named fields. >>> Point = namedtuple('Point', 'x y') >>> Point.__doc__ # docstring for the new class 'Point(x, y)' >>> p = Point(11, y=22) # instantiate with positional args or keywords >>> p[0] + p[1] # indexable like a plain tuple 33 >>> x, y = p # unpack like a regular tuple >>> x, y (11, 22) >>> p.x + p.y # fields also accessable by name 33 >>> d = p._asdict() # convert to a dictionary >>> d['x'] 11 >>> Point(**d) # convert from a dictionary Point(x=11, y=22) >>> p._replace(x=100) # _replace() is like str.replace() but targets named fields Point(x=100, y=22)

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict

type: type

doc: Dictionary that remembers insertion order

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.item.util.collections.OrderedDict._OrderedDict__marker

type: object

doc: The most base type

modo.item.util.collections.OrderedDict._OrderedDict__update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.item.util.collections.OrderedDict.clear(self)

type: instancemethod

doc: od.clear() -> None. Remove all items from od.

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.copy(self)

type: instancemethod

doc: od.copy() -> a shallow copy of od

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.fromkeys(cls,iterable,value)

type: instancemethod

doc: OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S. If not specified, the value defaults to None.

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.item.util.collections.OrderedDict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.item.util.collections.OrderedDict.items(self)

type: instancemethod

doc: od.items() -> list of (key, value) pairs in od

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.iteritems(self)

type: instancemethod

doc: od.iteritems -> an iterator over the (key, value) pairs in od

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.iterkeys(self)

type: instancemethod

doc: od.iterkeys() -> an iterator over the keys in od

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.itervalues(self)

type: instancemethod

doc: od.itervalues -> an iterator over the values in od

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.keys(self)

type: instancemethod

doc: od.keys() -> list of keys in od

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.pop(self,key,default)

type: instancemethod

doc: od.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.popitem(self,last)

type: instancemethod

doc: od.popitem() -> (k, v), return and remove a (key, value) pair. Pairs are returned in LIFO order if last is true or FIFO order if false.

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.setdefault(self,key,default)

type: instancemethod

doc: od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.item.util.collections.OrderedDict.values(self)

type: instancemethod

doc: od.values() -> list of values in od

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.viewitems(self)

type: instancemethod

doc: od.viewitems() -> a set-like object providing a view on od's items

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.viewkeys(self)

type: instancemethod

doc: od.viewkeys() -> a set-like object providing a view on od's keys

file: .\Lib\collections.py

modo.item.util.collections.OrderedDict.viewvalues(self)

type: instancemethod

doc: od.viewvalues() -> an object providing a view on od's values

file: .\Lib\collections.py

modo.item.util.collections.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.collections.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.item.util.ensureModoItem

type: function

doc: Decorator - ensures that the argument passed as the first parameter to a function is an instance of the modo :class:`Item` class. Should only only be used to decorate methods where the first argument is meant to be an item and ensures that if for any reason an item of either type lx.object.Item or lxu.object.Item gets passed to the method it will get wrapped as an modo.item.Item object before being used.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.util.floatEquals

type: function

doc: Test if two floats are equal :returns bool:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.util.functools

type: module

doc: functools.py - Tools for working with functions and callable objects

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

modo.item.util.functools.cmp_to_key

type: function

doc: Convert a cmp= function into a key= function

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.item.util.functools.partial

type: type

doc: partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

    modo.item.util.functools.partial contents:
  • modo.item.util.functools.partial.__call__
  • modo.item.util.functools.partial.__class__
  • modo.item.util.functools.partial.__delattr__
  • modo.item.util.functools.partial.__dict__
  • modo.item.util.functools.partial.__doc__
  • modo.item.util.functools.partial.__format__
  • modo.item.util.functools.partial.__getattribute__
  • modo.item.util.functools.partial.__hash__
  • modo.item.util.functools.partial.__init__
  • modo.item.util.functools.partial.__new__
  • modo.item.util.functools.partial.__reduce__
  • modo.item.util.functools.partial.__reduce_ex__
  • modo.item.util.functools.partial.__repr__
  • modo.item.util.functools.partial.__setattr__
  • modo.item.util.functools.partial.__setstate__
  • modo.item.util.functools.partial.__sizeof__
  • modo.item.util.functools.partial.__str__
  • modo.item.util.functools.partial.__subclasshook__
  • modo.item.util.functools.partial.args
  • modo.item.util.functools.partial.func
  • modo.item.util.functools.partial.keywords

modo.item.util.functools.partial.args

type: member_descriptor

doc: tuple of arguments to future partial calls

modo.item.util.functools.partial.func

type: member_descriptor

doc: function object to use in future partial calls

modo.item.util.functools.partial.keywords

type: member_descriptor

doc: dictionary of keyword arguments to future partial calls

modo.item.util.functools.reduce()

type: builtin_function_or_method

doc: reduce(function, sequence[, initial]) -> value Apply a function of two arguments cumulatively to the items of a sequence, from left to right, so as to reduce the sequence to a single value. For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates ((((1+2)+3)+4)+5). If initial is present, it is placed before the items of the sequence in the calculation, and serves as a default when the sequence is empty.

modo.item.util.functools.total_ordering

type: function

doc: Class decorator that fills in missing ordering methods

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.item.util.functools.update_wrapper

type: function

doc: Update a wrapper function to look like the wrapped function wrapper is the function to be updated wrapped is the original function assigned is a tuple naming the attributes assigned directly from the wrapped function to the wrapper function (defaults to functools.WRAPPER_ASSIGNMENTS) updated is a tuple naming the attributes of the wrapper that are updated with the corresponding attribute from the wrapped function (defaults to functools.WRAPPER_UPDATES)

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.item.util.functools.WRAPPER_ASSIGNMENTS

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.util.functools.WRAPPER_UPDATES

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.item.util.functools.wraps

type: function

doc: Decorator factory to apply update_wrapper() to a wrapper function Returns a decorator that invokes update_wrapper() with the decorated function as the wrapper argument and the arguments to wraps() as the remaining arguments. Default arguments are as for update_wrapper(). This is a convenience function to simplify applying partial() to update_wrapper().

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.item.util.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.item.util.makeQuickCommand

type: function

doc: Quick way to create a command. Note that a command can only be blessed (registered) once per modo session, so this command will fail when attempting to rebless a command. :param string name: Name that the command will be callable by. Example: cmds.myCommand :param function func: The function that the command should call :param iterable arguments: A sequence of name:defaultvalue pairs to make arguments that will be passed on to the function :param basestring userName: The user name :param basestring description: Summary of the command's purpose :param basestring toolTip: Text that appears when hovering over the button example:: import modo def func_args(mystring, myint): print mystring, myint def func_simple(): print 'simple function, no arguments' modo.util.makeQuickCommand('test.simple', func_simple) modo.util.makeQuickCommand('test.args', func_args, (('mystring', 'mesh021'), ('myint', 23))) lx.eval('test.simple') lx.eval('test.args mesh022 24')

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.util.paths

type: function

doc: Access to various system paths. :param basestring key: Specific path to return. Returns all if None. :returns dictionary or string: Dictionary containing all paths or single path as string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.util.testGlobalInterpreter

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.util.typeToFunc

type: function

doc: selects an item class constructor based on the item type passed as an argument and returns that as a class instantiation 'function' object to call the correct class in methods that eg select by item type or return items. In essence it acts as a sort of clearing house to try to ensure that any recognised but unwrapped items are wrapped with the correct modo.item.xxx type before being returned. example usage:: # get a list of all the light items in a scene where each light in the list is returned as the correctly # wrapped modo version of each light sub-type. import modo scene = modo.Scene() lights = [] for light in scene.ItemList(modo.c.LIGHT_TYPE): func = modo.c.typeToFunc(light.Type()) lights.append(func(light)) # or more succinctly as a list comprehension: lights = [modo.c.typeToFunc(light.Type())(light) for light in scene.ItemList(modo.c.LIGHT_TYPE)]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.item.Vector3

type: type

doc: Vector3 class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.angle(self,other)

type: instancemethod

doc: Returns the angle between this and another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.copy(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.cross(self,other)

type: instancemethod

doc: Returns a new vector with the result of crossing this vector with another

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.distanceBetweenPoints(self,other)

type: instancemethod

doc: Returns the distance between this and another point

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.dot(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.equals(self,other,tolerance)

type: instancemethod

doc: Returns if this vector is equivalent to another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.length(self)

type: instancemethod

doc: Returns the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.mulByMatrixAsPoint(self,other)

type: instancemethod

doc: Transform this point's position by a Matrix4 in place. :param Matrix4 other: Other Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.normal(self)

type: instancemethod

doc: Returns a normalized copy of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.normalize(self)

type: instancemethod

doc: Normalizes this vector in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.rotate(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.rotateByAxisAngle(self,axis,angle)

type: instancemethod

doc: Rotates this vector by a given axis and angle :param Vector3 axis: This axis to rotate about :param float angle: The angle in radians to rotate by

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.rotateByQuat(self,other)

type: instancemethod

doc: Rotate this vector by a quaternion

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.setLength(self,value)

type: instancemethod

doc: Sets the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.item.Vector3.x

type: property

doc: Quick access to the x component of the vector

modo.item.Vector3.y

type: property

doc: Quick access to the y component of the vector

modo.item.Vector3.z

type: property

doc: Quick access to the z component of the vector

modo.ItemGraph

type: type

doc: Utility container class for quick access to ItemGraph compatible graphs :param item: Item to look up graph for :param ls.symbol.sGRAPH_* graphType: Graph to look up. Common ones are 'parent', 'deformers', 'groups', 'chanMods' :param bool reverse: Indices traverse the graph forwards if false or reverse if true

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ItemGraph._ItemGraph__toType

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ItemGraph.connectedItems

type: property

doc: :getter: Returns a dictionary that lists the input- and output items at once. :rtype: dictionary

modo.ItemGraph.connectInput(self,other)

type: instancemethod

doc: Connects the given item as input. This function is called by the >> operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ItemGraph.disconnectInput(self,other)

type: instancemethod

doc: Removes the given item from the input connections if any. This function is called by the << operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ItemGraph.forward(self,index)

type: instancemethod

doc: :returns list: Items of the forward connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ItemGraph.item

type: property

doc: :getter: Returns the Item that this ItemGraph instance is bound to. :return type: Item

modo.ItemGraph.reverse(self,index)

type: instancemethod

doc: :returns list: Items of the reverse connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ItemGraph.setReverse(self,reverse)

type: instancemethod

doc: Sets the direction that is used for lookup when using the angular brackets [] :param bool reverse: If True the graph is looked up forwards, if False, backwards.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.ItemGraph.type

type: property

doc: :getter: Returns the name of the graph type that this instance represents. :return type: basestring

modo.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.Joint

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint._item

type: property

modo.Joint._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.Joint.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.Joint.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.Joint.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.Joint.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.Joint.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.Joint.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.Joint.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.Joint.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.Joint.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.Joint.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.Joint.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.Joint.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.Joint.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.Joint.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Joint.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Joint.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Joint.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Joint.scene

type: property

modo.Joint.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.Joint.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Joint.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Joint.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.Joint.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Keyframes

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Keyframes._indexFromTime(self,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Keyframes.add(self,val,time)

type: instancemethod

doc: Adds a new keyframe at the specified time. If no time value is passed as an argument a keyframe is set at the current time. :param time: optional time (in seconds) to add a keyframe at. :type time: float :param val: the value to set for the keyframe :type val: int or float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Keyframes.delete(self)

type: instancemethod

doc: Deletes the current key

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Keyframes.first(self)

type: instancemethod

doc: Go to the first keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Keyframes.getSlopeType(self,side)

type: instancemethod

doc: Returns the slope type for either side of a keyframe. :returns: a tuple of the slope type set for the side of the keyframe specified and whether the slope is weighted or not. :rtype: (int, int)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Keyframes.last(self)

type: instancemethod

doc: Go to the last keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Keyframes.next(self)

type: instancemethod

doc: Go to the next keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Keyframes.numKeys

type: property

doc: :getter: Returns the number of keyframes found :rtype: int

modo.Keyframes.prev(self)

type: instancemethod

doc: Go to the previous keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Keyframes.setIndex(self,index)

type: instancemethod

doc: Go to the keyframe by index

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Keyframes.setSlopeType(self,stype,side)

type: instancemethod

doc: Sets the slope type for either side of a keyframe - **SLOPE_DIRECT** the slope of the tangent is set based on the value stored in the key. - **SLOPE_AUTO** the slope of the tangent is calculated automatically with regard to surrounding keys. This is similar to the slope adjustments made by TCB curves. - **SLOPE_LINEAR_IN** the slope of the tangent is calculated to align with the previous key's value. - **SLOPE_LINEAR_OUT** the slope of the tangent is calculated to align with the next key's value. - **SLOPE_FLAT** The slope of the tangent is set to zero. - **SLOPE_AUTOFLAT** the same as auto but if a neighboring key has the same value as the key the slope is set to zero. - **SLOPE_STEPPED** Maintains the value of the previous key between pairs of keys. :param stype: set the slope type for the current keyframe. Can be one of: | lx.symbol.iSLOPE_AUTO | lx.symbol.iSLOPE_AUTOFLAT | lx.symbol.iSLOPE_DIRECT | lx.symbol.iSLOPE_FLAT | lx.symbol.iSLOPE_LINEAR_IN | lx.symbol.iSLOPE_LINEAR_OUT | lx.symbol.iSLOPE_STEPPED :type stype: int :param side: the side of the key (in or out) the slope type is being set for :type side: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.Keyframes.time

type: property

doc: Returns & sets the time for the current keyframe. :setter: Sets the time :param time: the time to move the key to. :type time: float :getter: Returns the time of the current keyframe :rtype: float

modo.Keyframes.value

type: property

doc: Convenience property to get & set value of the current keyframe for the 90% case of an unbroken key. :setter: Sets a value :param val: the value to set for the key. :type val: int or float :getter: Returns the value of an (unbroken) key. :rtype: int or float

modo.Light

type: type

doc: Base Light item class. Each light item encapsulates both an lx.object.Item object (via inheritance from the Item class) of a specific modo light type and a corresponding lx.object.Item of type 'lightMaterial' as a :class:`LightMaterial` object via the light's material property. example:: # to set the diffuse color on the currently selected spotlight spotlight = modo.SpotLight() spotlight.material.ch_diffCol.set((0.7, 0.1, 0.5)) .. note:: Although "Light" isn't technically a base class since, like all other classes in modo.item, it inherits from "Item", it does encapsulate modo's 'Light" supertype and can be treated as a kind of 'pseudo' base class for all modo's light types. As such it should not be instantiated directly, create one of the specific light types instead. | :param light: Optional light item object to wrap. Must be a specific type of light, not the light supertype. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid light item selected. :raises TypeError: if the item passed as an argument isn't an instance of a specific subclass of Light.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light._item

type: property

modo.Light._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.Light.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.Light.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.Light.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.Light.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.Light.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.Light.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.Light.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.Light.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.Light.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.Light.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.Light.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.Light.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.Light.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.Light.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.Light.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Light.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Light.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Light.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Light.scene

type: property

modo.Light.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.Light.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Light.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Light.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.Light.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.LightMaterial

type: type

doc: Wraps a light material texture layer item. :param material: the light material item to be wrapped. :type material: lx.object.Item of type lx.symbol.sITYPE_LIGHTMATERIAL

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial._item

type: property

modo.LightMaterial._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.LightMaterial.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.LightMaterial.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.LightMaterial.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.LightMaterial.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.LightMaterial.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.LightMaterial.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.LightMaterial.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.LightMaterial.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.LightMaterial.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.LightMaterial.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.light

type: property

doc: :getter: The light item that the material belongs to. :param light_item: the light item to parent the material layer to. :type light_item: an instance of one of the modo.Light types or either lx.object.Item or lxu.object.Item of a specific light item type :returns: the parent light item. :rtype: one of the modo light types.

modo.LightMaterial.lightCol

type: property

doc: A wrapper property for the light material item's three diffuse color channels. Returns an :class:`modo.channel.Channel` object :getter: Returns a channelTriple object. :rtype: modo.channel.channelTriple

modo.LightMaterial.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.LightMaterial.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.LightMaterial.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.LightMaterial.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.LightMaterial.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.scatteringCol

type: property

doc: :getter: A wrapper property for the light material item's three scattering color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.LightMaterial.scene

type: property

modo.LightMaterial.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.LightMaterial.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LightMaterial.shadCol

type: property

doc: :getter: A wrapper property for the light material item's three shadow color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.LightMaterial.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.LightMaterial.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Locator

type: type

doc: Locator item class. Takes an optional 'locator' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'locator' or an item name or ID to look up. If no locator item is supplied as an argument an attempt will be made to wrap the most recently selected locator item. :param locator: Optional locator item object (type lx.symbol.sITYPE_LOCATOR) or string (item name or ID) to look up. :type locator: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the locator argument but no item with that name/ID can be found. Hint: Items of other locator derived types should be casted as LocatorSuperType, casting to this class will fail.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator._item

type: property

modo.Locator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.Locator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.Locator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.Locator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.Locator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.Locator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.Locator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.Locator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.Locator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.Locator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.Locator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.Locator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.Locator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.Locator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.Locator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Locator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Locator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Locator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Locator.scene

type: property

modo.Locator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.Locator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Locator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Locator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.Locator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.LocatorSuperType

type: type

doc: The LocatorSuperType reflects all items that can be seen and transformed in the 3d view. Locators have transform items that hold the respective transform channels, such as position and rotation.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType._item

type: property

modo.LocatorSuperType._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.LocatorSuperType.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.LocatorSuperType.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.LocatorSuperType.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.LocatorSuperType.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.LocatorSuperType.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.LocatorSuperType.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.LocatorSuperType.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.LocatorSuperType.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.LocatorSuperType.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.LocatorSuperType.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.LocatorSuperType.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.LocatorSuperType.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.LocatorSuperType.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.LocatorSuperType.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.LocatorSuperType.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.LocatorSuperType.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.LocatorSuperType.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.LocatorSuperType.scene

type: property

modo.LocatorSuperType.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.LocatorSuperType.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.LocatorSuperType.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.LocatorSuperType.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.LocatorSuperType.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.mathutils

type: module

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.mathutils.math

type: module

doc: This module is always available. It provides access to the mathematical functions defined by the C standard.

modo.mathutils.math.acos()

type: builtin_function_or_method

doc: acos(x) Return the arc cosine (measured in radians) of x.

modo.mathutils.math.acosh()

type: builtin_function_or_method

doc: acosh(x) Return the hyperbolic arc cosine (measured in radians) of x.

modo.mathutils.math.asin()

type: builtin_function_or_method

doc: asin(x) Return the arc sine (measured in radians) of x.

modo.mathutils.math.asinh()

type: builtin_function_or_method

doc: asinh(x) Return the hyperbolic arc sine (measured in radians) of x.

modo.mathutils.math.atan()

type: builtin_function_or_method

doc: atan(x) Return the arc tangent (measured in radians) of x.

modo.mathutils.math.atan2()

type: builtin_function_or_method

doc: atan2(y, x) Return the arc tangent (measured in radians) of y/x. Unlike atan(y/x), the signs of both x and y are considered.

modo.mathutils.math.atanh()

type: builtin_function_or_method

doc: atanh(x) Return the hyperbolic arc tangent (measured in radians) of x.

modo.mathutils.math.ceil()

type: builtin_function_or_method

doc: ceil(x) Return the ceiling of x as a float. This is the smallest integral value >= x.

modo.mathutils.math.copysign()

type: builtin_function_or_method

doc: copysign(x, y) Return x with the sign of y.

modo.mathutils.math.cos()

type: builtin_function_or_method

doc: cos(x) Return the cosine of x (measured in radians).

modo.mathutils.math.cosh()

type: builtin_function_or_method

doc: cosh(x) Return the hyperbolic cosine of x.

modo.mathutils.math.degrees()

type: builtin_function_or_method

doc: degrees(x) Convert angle x from radians to degrees.

modo.mathutils.math.e

type: float

modo.mathutils.math.erf()

type: builtin_function_or_method

doc: erf(x) Error function at x.

modo.mathutils.math.erfc()

type: builtin_function_or_method

doc: erfc(x) Complementary error function at x.

modo.mathutils.math.exp()

type: builtin_function_or_method

doc: exp(x) Return e raised to the power of x.

modo.mathutils.math.expm1()

type: builtin_function_or_method

doc: expm1(x) Return exp(x)-1. This function avoids the loss of precision involved in the direct evaluation of exp(x)-1 for small x.

modo.mathutils.math.fabs()

type: builtin_function_or_method

doc: fabs(x) Return the absolute value of the float x.

modo.mathutils.math.factorial()

type: builtin_function_or_method

doc: factorial(x) -> Integral Find x!. Raise a ValueError if x is negative or non-integral.

modo.mathutils.math.floor()

type: builtin_function_or_method

doc: floor(x) Return the floor of x as a float. This is the largest integral value <= x.

modo.mathutils.math.fmod()

type: builtin_function_or_method

doc: fmod(x, y) Return fmod(x, y), according to platform C. x % y may differ.

modo.mathutils.math.frexp()

type: builtin_function_or_method

doc: frexp(x) Return the mantissa and exponent of x, as pair (m, e). m is a float and e is an int, such that x = m * 2.**e. If x is 0, m and e are both 0. Else 0.5 <= abs(m) < 1.0.

modo.mathutils.math.fsum()

type: builtin_function_or_method

doc: fsum(iterable) Return an accurate floating point sum of values in the iterable. Assumes IEEE-754 floating point arithmetic.

modo.mathutils.math.gamma()

type: builtin_function_or_method

doc: gamma(x) Gamma function at x.

modo.mathutils.math.hypot()

type: builtin_function_or_method

doc: hypot(x, y) Return the Euclidean distance, sqrt(x*x + y*y).

modo.mathutils.math.isinf()

type: builtin_function_or_method

doc: isinf(x) -> bool Check if float x is infinite (positive or negative).

modo.mathutils.math.isnan()

type: builtin_function_or_method

doc: isnan(x) -> bool Check if float x is not a number (NaN).

modo.mathutils.math.ldexp()

type: builtin_function_or_method

doc: ldexp(x, i) Return x * (2**i).

modo.mathutils.math.lgamma()

type: builtin_function_or_method

doc: lgamma(x) Natural logarithm of absolute value of Gamma function at x.

modo.mathutils.math.log()

type: builtin_function_or_method

doc: log(x[, base]) Return the logarithm of x to the given base. If the base not specified, returns the natural logarithm (base e) of x.

modo.mathutils.math.log10()

type: builtin_function_or_method

doc: log10(x) Return the base 10 logarithm of x.

modo.mathutils.math.log1p()

type: builtin_function_or_method

doc: log1p(x) Return the natural logarithm of 1+x (base e). The result is computed in a way which is accurate for x near zero.

modo.mathutils.math.modf()

type: builtin_function_or_method

doc: modf(x) Return the fractional and integer parts of x. Both results carry the sign of x and are floats.

modo.mathutils.math.pi

type: float

modo.mathutils.math.pow()

type: builtin_function_or_method

doc: pow(x, y) Return x**y (x to the power of y).

modo.mathutils.math.radians()

type: builtin_function_or_method

doc: radians(x) Convert angle x from degrees to radians.

modo.mathutils.math.sin()

type: builtin_function_or_method

doc: sin(x) Return the sine of x (measured in radians).

modo.mathutils.math.sinh()

type: builtin_function_or_method

doc: sinh(x) Return the hyperbolic sine of x.

modo.mathutils.math.sqrt()

type: builtin_function_or_method

doc: sqrt(x) Return the square root of x.

modo.mathutils.math.tan()

type: builtin_function_or_method

doc: tan(x) Return the tangent of x (measured in radians).

modo.mathutils.math.tanh()

type: builtin_function_or_method

doc: tanh(x) Return the hyperbolic tangent of x.

modo.mathutils.math.trunc()

type: builtin_function_or_method

doc: trunc(x:Real) -> Integral Truncates x to the nearest Integral toward 0. Uses the __trunc__ magic method.

modo.mathutils.Matrix3

type: type

doc: Matrix3 class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix3._getIdentity

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix3._MatrixToEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix3.asEuler(self,degrees,order)

type: instancemethod

doc: Returns euler values from the Matrix :param bool degrees: If True, the values are returned as degrees, otherwise as radians :param basestring order: The rotation order to return values for. :return list: Euler values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix3.copy(self)

type: instancemethod

doc: :return: A copy of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix3.invert(self)

type: instancemethod

doc: Inverts this Matrix in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix3.inverted(self)

type: instancemethod

doc: :returns Matrix: An inverted copy of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix3.set(self,other,transpose)

type: instancemethod

doc: Copy values from other Matrix :param Matrix other: Source Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix3.setIdentity(self)

type: instancemethod

doc: Set this matrix to it's identity

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix3.transpose(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix3.transposed(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal. It returns a new transposed matrix.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4

type: type

doc: Matrix class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4._getIdentity

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4._matrix_calcRotation

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4._matrix_vectorMultiply

type: function

doc: :param matrix: :param vector: :param result: :return:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4._MatrixToEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4._rotOrderToList

type: function

doc: takes a string in form of 'xyz' and returns a list in form of [0,1,2]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4.asEuler(self,degrees,order)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4.asRotateMatrix(self)

type: instancemethod

doc: Removes the translation part of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4.copy(self)

type: instancemethod

doc: :return: A copy of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4.determinant(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4.fromEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4.invert(self)

type: instancemethod

doc: Inverts this Matrix in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4.inverted(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4.position

type: property

doc: :getter: Returns the translation part of this matrix :rtype: tuple :setter: Sets the translation part of this matrix :param position: Position :type position: iterable

modo.mathutils.Matrix4.scale(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4.set(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4.setIdentity(self)

type: instancemethod

doc: Set this matrix to it's identity

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4.transpose(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Matrix4.transposed(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal. It returns a new transposed matrix.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.MIN_PRECISION

type: float
modo.mathutils.Quaternion

type: type

doc: Minimal quaternion class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion._Quaternion__dTolerance

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion._quaternion_identity

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion._quaternion_length

type: function

doc: This function calculates the length of the quaternion. :param Quaternion q: :returns float:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion._quaternion_normalize

type: function

doc: This function normalizes a quaternion, setting the length of the quaternion to 1.0. :param Quaternion q: :return:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion.copy(self)

type: instancemethod

doc: Returns a copy of this quaternion object

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion.fromMatrix3(self,input)

type: instancemethod

doc: This function converts a matrix into a quaternion, containing the same rotation. :param Matrix3 input: :param Quaternion output:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion.fromMatrix4(self,input)

type: instancemethod

doc: This function converts a matrix into a quaternion, containing the same rotation. :param Matrix4 input:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion.getAxisAngle(self)

type: instancemethod

doc: Returns the axis and angle of this quaternion :returns tuple: Axis [tuple] and angle [float]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion.length(self)

type: instancemethod

doc: Returns the length of this quaternion

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion.normalize(self)

type: instancemethod

doc: Normalizes the quaternion in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion.setAxisAngle(self,axis,angle)

type: instancemethod

doc: This function takes an axis and an angle, and calculates a quaternion that encodes that rotation. :param float angle: Angle in radians :param Vector3 axis: Axis

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion.toMatrix3(self)

type: instancemethod

doc: This function converts a quaternion into a Matrix3, containing the same rotation. :return Matrix3: Result

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion.toMatrix4(self)

type: instancemethod

doc: :returns Matrix4: This quaternion as Matrix4, containing the same rotation

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Quaternion.w

type: property

doc: Quick access to the w component of the quaternion

modo.mathutils.Quaternion.x

type: property

doc: Quick access to the x component of the quaternion

modo.mathutils.Quaternion.y

type: property

doc: Quick access to the y component of the quaternion

modo.mathutils.Quaternion.z

type: property

doc: Quick access to the z component of the quaternion

modo.mathutils.QW

type: int

modo.mathutils.QX

type: int

modo.mathutils.QY

type: int

modo.mathutils.QZ

type: int
modo.mathutils.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.mathutils.sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.mathutils.sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.mathutils.sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.mathutils.sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mathutils.sys.api_version

type: int

modo.mathutils.sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mathutils.sys.byteorder

type: str

modo.mathutils.sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.mathutils.sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.mathutils.sys.copyright

type: str

modo.mathutils.sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.mathutils.sys.dllhandle

type: long

modo.mathutils.sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mathutils.sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.mathutils.sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.mathutils.sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.mathutils.sys.exc_type

type: type

doc: Inappropriate argument type.

    modo.mathutils.sys.exc_type contents:
  • modo.mathutils.sys.exc_type.__class__
  • modo.mathutils.sys.exc_type.__delattr__
  • modo.mathutils.sys.exc_type.__dict__
  • modo.mathutils.sys.exc_type.__doc__
  • modo.mathutils.sys.exc_type.__format__
  • modo.mathutils.sys.exc_type.__getattribute__
  • modo.mathutils.sys.exc_type.__getitem__
  • modo.mathutils.sys.exc_type.__getslice__
  • modo.mathutils.sys.exc_type.__hash__
  • modo.mathutils.sys.exc_type.__init__
  • modo.mathutils.sys.exc_type.__new__
  • modo.mathutils.sys.exc_type.__reduce__
  • modo.mathutils.sys.exc_type.__reduce_ex__
  • modo.mathutils.sys.exc_type.__repr__
  • modo.mathutils.sys.exc_type.__setattr__
  • modo.mathutils.sys.exc_type.__setstate__
  • modo.mathutils.sys.exc_type.__sizeof__
  • modo.mathutils.sys.exc_type.__str__
  • modo.mathutils.sys.exc_type.__subclasshook__
  • modo.mathutils.sys.exc_type.__unicode__
  • modo.mathutils.sys.exc_type.args
  • modo.mathutils.sys.exc_type.message

modo.mathutils.sys.exc_type.args

type: getset_descriptor

modo.mathutils.sys.exc_type.message

type: getset_descriptor

modo.mathutils.sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.mathutils.sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.mathutils.sys.exec_prefix

type: str

modo.mathutils.sys.executable

type: str

modo.mathutils.sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.mathutils.sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.mathutils.sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.mathutils.sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.mathutils.sys.float_repr_style

type: str

modo.mathutils.sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.mathutils.sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.mathutils.sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.mathutils.sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.mathutils.sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.mathutils.sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.mathutils.sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.mathutils.sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.mathutils.sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.mathutils.sys.hexversion

type: int

modo.mathutils.sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.mathutils.sys.maxint

type: int

modo.mathutils.sys.maxsize

type: long

modo.mathutils.sys.maxunicode

type: int

modo.mathutils.sys.meta_path

type: list
modo.mathutils.sys.modules type: dict

modo.mathutils.sys.modules.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mathutils.sys.modules.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mathutils.sys.modules.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mathutils.sys.modules.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mathutils.sys.modules.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mathutils.sys.modules.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mathutils.sys.modules.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mathutils.sys.modules.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mathutils.sys.modules.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mathutils.sys.modules.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mathutils.sys.modules.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mathutils.sys.modules.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mathutils.sys.modules.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mathutils.sys.modules.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mathutils.sys.modules.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mathutils.sys.modules.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mathutils.sys.modules.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mathutils.sys.modules.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mathutils.sys.path

type: list

modo.mathutils.sys.path_hooks

type: list
modo.mathutils.sys.path_importer_cache type: dict

modo.mathutils.sys.path_importer_cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mathutils.sys.path_importer_cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mathutils.sys.path_importer_cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mathutils.sys.path_importer_cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mathutils.sys.path_importer_cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mathutils.sys.path_importer_cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mathutils.sys.path_importer_cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mathutils.sys.path_importer_cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mathutils.sys.path_importer_cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mathutils.sys.path_importer_cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mathutils.sys.path_importer_cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mathutils.sys.path_importer_cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mathutils.sys.path_importer_cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mathutils.sys.path_importer_cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mathutils.sys.path_importer_cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mathutils.sys.path_importer_cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mathutils.sys.path_importer_cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mathutils.sys.path_importer_cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mathutils.sys.platform

type: str

modo.mathutils.sys.prefix

type: str

modo.mathutils.sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mathutils.sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.mathutils.sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.mathutils.sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.mathutils.sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.mathutils.sys.stderr

type: SESysStdErr

modo.mathutils.sys.stdin

type: SESysStdIn

modo.mathutils.sys.stdout

type: SESysStdOut

modo.mathutils.sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mathutils.sys.version

type: str

modo.mathutils.sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.mathutils.sys.warnoptions

type: list

modo.mathutils.sys.winver

type: str
modo.mathutils.vector

type: module

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.pyc

modo.mathutils.vector.add

type: function

doc: result = a + b

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.mathutils.vector.cross

type: function

doc: result = a x b

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.mathutils.vector.dot

type: function

doc: result = a . b

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.mathutils.vector.length

type: function

doc: result = sqrt (v . v)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.mathutils.vector.math

type: module

doc: This module is always available. It provides access to the mathematical functions defined by the C standard.

modo.mathutils.vector.math.acos()

type: builtin_function_or_method

doc: acos(x) Return the arc cosine (measured in radians) of x.

modo.mathutils.vector.math.acosh()

type: builtin_function_or_method

doc: acosh(x) Return the hyperbolic arc cosine (measured in radians) of x.

modo.mathutils.vector.math.asin()

type: builtin_function_or_method

doc: asin(x) Return the arc sine (measured in radians) of x.

modo.mathutils.vector.math.asinh()

type: builtin_function_or_method

doc: asinh(x) Return the hyperbolic arc sine (measured in radians) of x.

modo.mathutils.vector.math.atan()

type: builtin_function_or_method

doc: atan(x) Return the arc tangent (measured in radians) of x.

modo.mathutils.vector.math.atan2()

type: builtin_function_or_method

doc: atan2(y, x) Return the arc tangent (measured in radians) of y/x. Unlike atan(y/x), the signs of both x and y are considered.

modo.mathutils.vector.math.atanh()

type: builtin_function_or_method

doc: atanh(x) Return the hyperbolic arc tangent (measured in radians) of x.

modo.mathutils.vector.math.ceil()

type: builtin_function_or_method

doc: ceil(x) Return the ceiling of x as a float. This is the smallest integral value >= x.

modo.mathutils.vector.math.copysign()

type: builtin_function_or_method

doc: copysign(x, y) Return x with the sign of y.

modo.mathutils.vector.math.cos()

type: builtin_function_or_method

doc: cos(x) Return the cosine of x (measured in radians).

modo.mathutils.vector.math.cosh()

type: builtin_function_or_method

doc: cosh(x) Return the hyperbolic cosine of x.

modo.mathutils.vector.math.degrees()

type: builtin_function_or_method

doc: degrees(x) Convert angle x from radians to degrees.

modo.mathutils.vector.math.e

type: float

modo.mathutils.vector.math.erf()

type: builtin_function_or_method

doc: erf(x) Error function at x.

modo.mathutils.vector.math.erfc()

type: builtin_function_or_method

doc: erfc(x) Complementary error function at x.

modo.mathutils.vector.math.exp()

type: builtin_function_or_method

doc: exp(x) Return e raised to the power of x.

modo.mathutils.vector.math.expm1()

type: builtin_function_or_method

doc: expm1(x) Return exp(x)-1. This function avoids the loss of precision involved in the direct evaluation of exp(x)-1 for small x.

modo.mathutils.vector.math.fabs()

type: builtin_function_or_method

doc: fabs(x) Return the absolute value of the float x.

modo.mathutils.vector.math.factorial()

type: builtin_function_or_method

doc: factorial(x) -> Integral Find x!. Raise a ValueError if x is negative or non-integral.

modo.mathutils.vector.math.floor()

type: builtin_function_or_method

doc: floor(x) Return the floor of x as a float. This is the largest integral value <= x.

modo.mathutils.vector.math.fmod()

type: builtin_function_or_method

doc: fmod(x, y) Return fmod(x, y), according to platform C. x % y may differ.

modo.mathutils.vector.math.frexp()

type: builtin_function_or_method

doc: frexp(x) Return the mantissa and exponent of x, as pair (m, e). m is a float and e is an int, such that x = m * 2.**e. If x is 0, m and e are both 0. Else 0.5 <= abs(m) < 1.0.

modo.mathutils.vector.math.fsum()

type: builtin_function_or_method

doc: fsum(iterable) Return an accurate floating point sum of values in the iterable. Assumes IEEE-754 floating point arithmetic.

modo.mathutils.vector.math.gamma()

type: builtin_function_or_method

doc: gamma(x) Gamma function at x.

modo.mathutils.vector.math.hypot()

type: builtin_function_or_method

doc: hypot(x, y) Return the Euclidean distance, sqrt(x*x + y*y).

modo.mathutils.vector.math.isinf()

type: builtin_function_or_method

doc: isinf(x) -> bool Check if float x is infinite (positive or negative).

modo.mathutils.vector.math.isnan()

type: builtin_function_or_method

doc: isnan(x) -> bool Check if float x is not a number (NaN).

modo.mathutils.vector.math.ldexp()

type: builtin_function_or_method

doc: ldexp(x, i) Return x * (2**i).

modo.mathutils.vector.math.lgamma()

type: builtin_function_or_method

doc: lgamma(x) Natural logarithm of absolute value of Gamma function at x.

modo.mathutils.vector.math.log()

type: builtin_function_or_method

doc: log(x[, base]) Return the logarithm of x to the given base. If the base not specified, returns the natural logarithm (base e) of x.

modo.mathutils.vector.math.log10()

type: builtin_function_or_method

doc: log10(x) Return the base 10 logarithm of x.

modo.mathutils.vector.math.log1p()

type: builtin_function_or_method

doc: log1p(x) Return the natural logarithm of 1+x (base e). The result is computed in a way which is accurate for x near zero.

modo.mathutils.vector.math.modf()

type: builtin_function_or_method

doc: modf(x) Return the fractional and integer parts of x. Both results carry the sign of x and are floats.

modo.mathutils.vector.math.pi

type: float

modo.mathutils.vector.math.pow()

type: builtin_function_or_method

doc: pow(x, y) Return x**y (x to the power of y).

modo.mathutils.vector.math.radians()

type: builtin_function_or_method

doc: radians(x) Convert angle x from degrees to radians.

modo.mathutils.vector.math.sin()

type: builtin_function_or_method

doc: sin(x) Return the sine of x (measured in radians).

modo.mathutils.vector.math.sinh()

type: builtin_function_or_method

doc: sinh(x) Return the hyperbolic sine of x.

modo.mathutils.vector.math.sqrt()

type: builtin_function_or_method

doc: sqrt(x) Return the square root of x.

modo.mathutils.vector.math.tan()

type: builtin_function_or_method

doc: tan(x) Return the tangent of x (measured in radians).

modo.mathutils.vector.math.tanh()

type: builtin_function_or_method

doc: tanh(x) Return the hyperbolic tangent of x.

modo.mathutils.vector.math.trunc()

type: builtin_function_or_method

doc: trunc(x:Real) -> Integral Truncates x to the nearest Integral toward 0. Uses the __trunc__ magic method.

modo.mathutils.vector.normalize

type: function

doc: result = a / length(a)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.mathutils.vector.scale

type: function

doc: result = v * s

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.mathutils.vector.sub

type: function

doc: result = a - b

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.mathutils.vector.vector

type: function

doc: Return a 3-vector (tuple of three values): Vector(x,y,z) = (x,y,z) Vector(a) = (a,a,a) Vector() = (0,0,0)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.mathutils.Vector3

type: type

doc: Vector3 class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.angle(self,other)

type: instancemethod

doc: Returns the angle between this and another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.copy(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.cross(self,other)

type: instancemethod

doc: Returns a new vector with the result of crossing this vector with another

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.distanceBetweenPoints(self,other)

type: instancemethod

doc: Returns the distance between this and another point

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.dot(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.equals(self,other,tolerance)

type: instancemethod

doc: Returns if this vector is equivalent to another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.length(self)

type: instancemethod

doc: Returns the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.mulByMatrixAsPoint(self,other)

type: instancemethod

doc: Transform this point's position by a Matrix4 in place. :param Matrix4 other: Other Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.normal(self)

type: instancemethod

doc: Returns a normalized copy of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.normalize(self)

type: instancemethod

doc: Normalizes this vector in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.rotate(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.rotateByAxisAngle(self,axis,angle)

type: instancemethod

doc: Rotates this vector by a given axis and angle :param Vector3 axis: This axis to rotate about :param float angle: The angle in radians to rotate by

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.rotateByQuat(self,other)

type: instancemethod

doc: Rotate this vector by a quaternion

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.setLength(self,value)

type: instancemethod

doc: Sets the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.mathutils.Vector3.x

type: property

doc: Quick access to the x component of the vector

modo.mathutils.Vector3.y

type: property

doc: Quick access to the y component of the vector

modo.mathutils.Vector3.z

type: property

doc: Quick access to the z component of the vector

modo.Matrix3

type: type

doc: Matrix3 class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix3._getIdentity

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix3._MatrixToEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix3.asEuler(self,degrees,order)

type: instancemethod

doc: Returns euler values from the Matrix :param bool degrees: If True, the values are returned as degrees, otherwise as radians :param basestring order: The rotation order to return values for. :return list: Euler values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix3.copy(self)

type: instancemethod

doc: :return: A copy of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix3.invert(self)

type: instancemethod

doc: Inverts this Matrix in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix3.inverted(self)

type: instancemethod

doc: :returns Matrix: An inverted copy of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix3.set(self,other,transpose)

type: instancemethod

doc: Copy values from other Matrix :param Matrix other: Source Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix3.setIdentity(self)

type: instancemethod

doc: Set this matrix to it's identity

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix3.transpose(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix3.transposed(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal. It returns a new transposed matrix.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4

type: type

doc: Matrix class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4._getIdentity

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4._matrix_calcRotation

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4._matrix_vectorMultiply

type: function

doc: :param matrix: :param vector: :param result: :return:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4._MatrixToEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4._rotOrderToList

type: function

doc: takes a string in form of 'xyz' and returns a list in form of [0,1,2]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4.asEuler(self,degrees,order)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4.asRotateMatrix(self)

type: instancemethod

doc: Removes the translation part of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4.copy(self)

type: instancemethod

doc: :return: A copy of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4.determinant(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4.fromEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4.invert(self)

type: instancemethod

doc: Inverts this Matrix in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4.inverted(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4.position

type: property

doc: :getter: Returns the translation part of this matrix :rtype: tuple :setter: Sets the translation part of this matrix :param position: Position :type position: iterable

modo.Matrix4.scale(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4.set(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4.setIdentity(self)

type: instancemethod

doc: Set this matrix to it's identity

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4.transpose(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Matrix4.transposed(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal. It returns a new transposed matrix.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Mesh

type: type

doc: Mesh item class. Takes an optional 'mesh' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'mesh' or an item name or ID to look up. If no mesh item is supplied as an argument an attempt will be made to wrap the most recently selected mesh layer. :param mesh: Optional mesh item object (type lx.symbol.sITYPE_MESH) or string (item name or ID) to look up. :type mesh: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid mesh item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'mesh' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the mesh argument but no item with that name/ID can be found. The mesh geometry can be accessed by the :class:`geometry` attribute. .. py:attribute:: geometry :rtype: :class:`MeshGeometry`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh._item

type: property

modo.Mesh._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.Mesh.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.Mesh.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.Mesh.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.Mesh.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.geometry

type: property

modo.Mesh.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.Mesh.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.Mesh.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.Mesh.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.Mesh.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.Mesh.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.Mesh.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.Mesh.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.Mesh.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.Mesh.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.Mesh.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Mesh.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Mesh.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Mesh.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Mesh.scene

type: property

modo.Mesh.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.Mesh.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Mesh.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Mesh.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.Mesh.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.MeshComponentContainer

type: type

doc: Base class for vertex, edge- and polygon containers to share common behaviour

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshComponentContainer._getitem(self,index,cls)

type: instancemethod

doc: General access for angular brackets

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshComponentContainer.internalMesh

type: property

doc: :getter: returns the wrapped lx.object.Mesh object

modo.MeshEdge

type: type

doc: Class representing an edge

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdge._accessor

type: property

modo.MeshEdge._MeshEdge__apply_operator(self,func_name,operand)

type: instancemethod

doc: Helper function for operators

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdge.accessor

type: property

doc: :getter: Returns the internal shared EdgeAccessor object of the core SDK (lx.object.Edge)

modo.MeshEdge.deselect(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdge.fromID(cls,id,geometry)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdge.fromIDs(cls,id1,id2,parent,mesh)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdge.fromVertices(cls,vertices,parent,mesh)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdge.id

type: property

doc: :getter: Returns the pointer ID of this edge

modo.MeshEdge.polygons

type: property

doc: :getter: Returns the polygons connected to this edge

modo.MeshEdge.select(self,replace)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdge.vertex_indices

type: property

doc: :getter: Returns the connected vertex indices as tuple

modo.MeshEdge.vertices

type: property

doc: :getter: Returns the connected :class:`vertices` as tuple

modo.MeshEdges

type: type

doc: Extension class of the Edge accessor lx.object.Edge that adds iteration methods. Note: Modo does not store edges by index, therefore they cannot be accessed by such. You can use the built-in python iterator however. :param mesh: Input mesh to obtain PointAccessor from :param parent: MeshGeometry parent object

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdges._getitem(self,index,cls)

type: instancemethod

doc: General access for angular brackets

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdges._MeshEdges__pollEdgeIDs(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdges._performSelectionOperation

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdges.enumerate(self,mode,visitor,monitor)

type: instancemethod

doc: Enumerate edges using a visitor :param int mode: lx.symbol.iMARK_ANY :param lxifc.Visitor visitor: Visitor class instance to use :param monitor: Optional monitor (progress bar) to display

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdges.fromVertices(self,vertices)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdges.internalMesh

type: property

doc: :getter: returns the wrapped lx.object.Mesh object

modo.MeshEdges.select(self,edges,replace)

type: instancemethod

doc: Selects one or multiple edges of this mesh :param list or tuple edges: index, MeshEdge, or sequence of indices or MeshEdge objects. If None, the selection is cleared. :param bool replace: Clears the selection first

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshEdges.selected

type: property

doc: :getter: Returns the currently selected edges as tuple

modo.MeshGeometry

type: type

doc: A class wrapped around lx.object.Mesh that provides access to geometry of a given Mesh Item :param item: Input item :type item: type lx.object.Item :param mode: Mode in which to access the mesh. Possible values: "write", "read", "deformed" :type mode: string. Note: References are always read only. :return: Instance of MeshGeometry :raises LookupError: If item was passed as string and could not be found in the scene :raises TypeError: If the passed item is not of type lx.object.Item :raises TypeError: If the passed item is not compatible with the mesh type example:: scene = modo.scene.current() # Get the selected mesh for mesh in scene.selectedByType("mesh")[:1]: # Print the number of vertices print len(mesh.geometry.vertices) # Print point position by index print mesh.geometry.vertices[4] # Set point position by index mesh.geometry.vertices[4] = (1,2,3) # Iterate all vertices and move them by 0.1 in x for point in mesh.geometry.vertices: point += (0.1, 0, 0) # Update to see mesh changes mesh.geometry.setMeshEdits() .. py:attribute:: vertices :rtype: :class:`MeshVertices` .. py:attribute:: edges :rtype: :class:`MeshEdges` .. py:attribute:: polygons :rtype: :class:`MeshPolygons` .. py:attribute:: vmaps :rtype: :class:`MeshMaps`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshGeometry._item

type: property

modo.MeshGeometry._SEL_SVC

type: Selection

modo.MeshGeometry._UNDO_SVC

type: Undo

modo.MeshGeometry.accessMode

type: property

modo.MeshGeometry.boundingBox

type: property

doc: Get the bounding box of this mesh :getter: Returns a tuple representing the two corners of the bounding box

modo.MeshGeometry.getMeshCenter(self)

type: instancemethod

doc: :return: Center position of the bounding box

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshGeometry.internalMesh

type: property

doc: :getter: Returns the wrapped lx.object.Mesh object

modo.MeshGeometry.numEdges

type: property

doc: :getter: returns the vertex count of this mesh

modo.MeshGeometry.numPolygons

type: property

doc: :getter: returns the polygon count of this mesh

modo.MeshGeometry.numVertices

type: property

doc: :getter: returns the vertex count of this mesh

modo.MeshGeometry.setAccessMode(self,value,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshGeometry.setMeshEdits(self,editType)

type: instancemethod

doc: Updates mesh edits applying previous changes. :param lx.symbol.f_MESHEDIT_* editType: The type of change to set. Defaults to all.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry

type: module

doc: .. module:: modo.meshgeometry :synopsis: Classes for mesh access and editing .. moduleauthor:: Ivo Grigull

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.collections

type: module

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.meshgeometry.collections._abcoll

type: module

doc: Abstract Base Classes (ABCs) for collections, according to PEP 3119. DON'T USE THIS MODULE DIRECTLY! The classes here should be imported via collections; they are defined here only to alleviate certain bootstrapping issues. Unit tests are in test_collections.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll._hasattr

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.meshgeometry.collections._abcoll.ABCMeta

type: type

doc: Metaclass for defining Abstract Base Classes (ABCs). Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as 'virtual subclasses' -- these and their descendants will be considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won't show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via super()).

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\abc.pyc

    modo.meshgeometry.collections._abcoll.ABCMeta contents:
  • modo.meshgeometry.collections._abcoll.ABCMeta.__base__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__bases__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__basicsize__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__call__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__class__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__delattr__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__dict__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__dictoffset__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__doc__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__eq__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__flags__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__format__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__ge__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__getattribute__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__gt__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__hash__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__init__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__instancecheck__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__itemsize__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__le__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__lt__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__module__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__mro__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__name__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__ne__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__new__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__reduce__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__reduce_ex__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__repr__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__setattr__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__sizeof__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__str__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__subclasscheck__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__subclasses__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__subclasshook__
  • modo.meshgeometry.collections._abcoll.ABCMeta.__weakrefoffset__
  • modo.meshgeometry.collections._abcoll.ABCMeta._abc_invalidation_counter
  • modo.meshgeometry.collections._abcoll.ABCMeta._dump_registry
  • modo.meshgeometry.collections._abcoll.ABCMeta.mro
  • modo.meshgeometry.collections._abcoll.ABCMeta.register

modo.meshgeometry.collections._abcoll.ABCMeta._abc_invalidation_counter

type: int

modo.meshgeometry.collections._abcoll.ABCMeta._dump_registry(cls,file)

type: instancemethod

doc: Debug helper to print the ABC registry.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.meshgeometry.collections._abcoll.ABCMeta.mro()

type: method_descriptor

doc: mro() -> list return a type's method resolution order

modo.meshgeometry.collections._abcoll.ABCMeta.register(cls,subclass)

type: instancemethod

doc: Register a virtual subclass of an ABC.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.meshgeometry.collections._abcoll.abstractmethod

type: function

doc: A decorator indicating abstract methods. Requires that the metaclass is ABCMeta or derived from it. A class that has a metaclass derived from ABCMeta cannot be instantiated unless all of its abstract methods are overridden. The abstract methods can be called using any of the normal 'super' call mechanisms. Usage: class C: __metaclass__ = ABCMeta @abstractmethod def my_abstract_method(self, ...): ...

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.meshgeometry.collections._abcoll.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._abcoll.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.meshgeometry.collections._abcoll.sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.meshgeometry.collections._abcoll.sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.meshgeometry.collections._abcoll.sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.meshgeometry.collections._abcoll.sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.collections._abcoll.sys.api_version

type: int

modo.meshgeometry.collections._abcoll.sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.collections._abcoll.sys.byteorder

type: str

modo.meshgeometry.collections._abcoll.sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.meshgeometry.collections._abcoll.sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.meshgeometry.collections._abcoll.sys.copyright

type: str

modo.meshgeometry.collections._abcoll.sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.meshgeometry.collections._abcoll.sys.dllhandle

type: long

modo.meshgeometry.collections._abcoll.sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.meshgeometry.collections._abcoll.sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.meshgeometry.collections._abcoll.sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.meshgeometry.collections._abcoll.sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.meshgeometry.collections._abcoll.sys.exc_type

type: type

doc: Inappropriate argument type.

    modo.meshgeometry.collections._abcoll.sys.exc_type contents:
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__class__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__delattr__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__dict__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__doc__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__format__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__getattribute__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__getitem__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__getslice__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__hash__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__init__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__new__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__reduce__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__reduce_ex__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__repr__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__setattr__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__setstate__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__sizeof__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__str__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__subclasshook__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.__unicode__
  • modo.meshgeometry.collections._abcoll.sys.exc_type.args
  • modo.meshgeometry.collections._abcoll.sys.exc_type.message

modo.meshgeometry.collections._abcoll.sys.exc_type.args

type: getset_descriptor

modo.meshgeometry.collections._abcoll.sys.exc_type.message

type: getset_descriptor

modo.meshgeometry.collections._abcoll.sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.meshgeometry.collections._abcoll.sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.meshgeometry.collections._abcoll.sys.exec_prefix

type: str

modo.meshgeometry.collections._abcoll.sys.executable

type: str

modo.meshgeometry.collections._abcoll.sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.meshgeometry.collections._abcoll.sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.meshgeometry.collections._abcoll.sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.meshgeometry.collections._abcoll.sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.meshgeometry.collections._abcoll.sys.float_repr_style

type: str

modo.meshgeometry.collections._abcoll.sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.meshgeometry.collections._abcoll.sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.meshgeometry.collections._abcoll.sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.meshgeometry.collections._abcoll.sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.meshgeometry.collections._abcoll.sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.meshgeometry.collections._abcoll.sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.meshgeometry.collections._abcoll.sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.meshgeometry.collections._abcoll.sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.meshgeometry.collections._abcoll.sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.meshgeometry.collections._abcoll.sys.hexversion

type: int

modo.meshgeometry.collections._abcoll.sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.meshgeometry.collections._abcoll.sys.maxint

type: int

modo.meshgeometry.collections._abcoll.sys.maxsize

type: long

modo.meshgeometry.collections._abcoll.sys.maxunicode

type: int

modo.meshgeometry.collections._abcoll.sys.meta_path

type: list
modo.meshgeometry.collections._abcoll.sys.modules type: dict

modo.meshgeometry.collections._abcoll.sys.modules.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.meshgeometry.collections._abcoll.sys.modules.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.meshgeometry.collections._abcoll.sys.modules.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.meshgeometry.collections._abcoll.sys.modules.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.collections._abcoll.sys.modules.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.collections._abcoll.sys.modules.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.meshgeometry.collections._abcoll.sys.modules.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.meshgeometry.collections._abcoll.sys.modules.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.meshgeometry.collections._abcoll.sys.modules.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.meshgeometry.collections._abcoll.sys.modules.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.meshgeometry.collections._abcoll.sys.modules.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.meshgeometry.collections._abcoll.sys.modules.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.meshgeometry.collections._abcoll.sys.modules.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.meshgeometry.collections._abcoll.sys.modules.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.meshgeometry.collections._abcoll.sys.modules.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.meshgeometry.collections._abcoll.sys.modules.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.meshgeometry.collections._abcoll.sys.modules.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.meshgeometry.collections._abcoll.sys.modules.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.meshgeometry.collections._abcoll.sys.path

type: list

modo.meshgeometry.collections._abcoll.sys.path_hooks

type: list
modo.meshgeometry.collections._abcoll.sys.path_importer_cache type: dict

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.meshgeometry.collections._abcoll.sys.path_importer_cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.meshgeometry.collections._abcoll.sys.platform

type: str

modo.meshgeometry.collections._abcoll.sys.prefix

type: str

modo.meshgeometry.collections._abcoll.sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.meshgeometry.collections._abcoll.sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.meshgeometry.collections._abcoll.sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.meshgeometry.collections._abcoll.sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.meshgeometry.collections._abcoll.sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.meshgeometry.collections._abcoll.sys.stderr

type: SESysStdErr

modo.meshgeometry.collections._abcoll.sys.stdin

type: SESysStdIn

modo.meshgeometry.collections._abcoll.sys.stdout

type: SESysStdOut

modo.meshgeometry.collections._abcoll.sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.collections._abcoll.sys.version

type: str

modo.meshgeometry.collections._abcoll.sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.meshgeometry.collections._abcoll.sys.warnoptions

type: list

modo.meshgeometry.collections._abcoll.sys.winver

type: str

modo.meshgeometry.collections._abcoll.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections._chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.meshgeometry.collections._chain contents:
  • modo.meshgeometry.collections._chain.__class__
  • modo.meshgeometry.collections._chain.__delattr__
  • modo.meshgeometry.collections._chain.__doc__
  • modo.meshgeometry.collections._chain.__format__
  • modo.meshgeometry.collections._chain.__getattribute__
  • modo.meshgeometry.collections._chain.__hash__
  • modo.meshgeometry.collections._chain.__init__
  • modo.meshgeometry.collections._chain.__iter__
  • modo.meshgeometry.collections._chain.__new__
  • modo.meshgeometry.collections._chain.__reduce__
  • modo.meshgeometry.collections._chain.__reduce_ex__
  • modo.meshgeometry.collections._chain.__repr__
  • modo.meshgeometry.collections._chain.__setattr__
  • modo.meshgeometry.collections._chain.__sizeof__
  • modo.meshgeometry.collections._chain.__str__
  • modo.meshgeometry.collections._chain.__subclasshook__
  • modo.meshgeometry.collections._chain.from_iterable
  • modo.meshgeometry.collections._chain.next

modo.meshgeometry.collections._chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.meshgeometry.collections._chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.collections._get_ident()

type: builtin_function_or_method

doc: get_ident() -> integer Return a non-zero integer that uniquely identifies the current thread amongst other threads that exist simultaneously. This may be used to identify per-thread resources. Even though on some platforms threads identities may appear to be allocated consecutive numbers starting at 1, this behavior should not be relied upon, and the number should be seen purely as a magic cookie. A thread's identity may be reused for another thread after it exits.

modo.meshgeometry.collections._heapq

type: module

doc: Heap queue algorithm (a.k.a. priority queue). Heaps are arrays for which a[k] <= a[2*k+1] and a[k] <= a[2*k+2] for all k, counting elements from 0. For the sake of comparison, non-existing elements are considered to be infinite. The interesting property of a heap is that a[0] is always its smallest element. Usage: heap = [] # creates an empty heap heappush(heap, item) # pushes a new item on the heap item = heappop(heap) # pops the smallest item from the heap item = heap[0] # smallest item on the heap without popping it heapify(x) # transforms list into a heap, in-place, in linear time item = heapreplace(heap, item) # pops and returns smallest item, and adds # new item; the heap size is unchanged Our API differs from textbook heap algorithms as follows: - We use 0-based indexing. This makes the relationship between the index for a node and the indexes for its children slightly less obvious, but is more suitable since Python uses 0-based indexing. - Our heappop() method returns the smallest item, not the largest. These two make it possible to view the heap as a regular Python list without surprises: heap[0] is the smallest item, and heap.sort() maintains the heap invariant!

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\heapq.pyc

modo.meshgeometry.collections._heapq._nlargest()

type: builtin_function_or_method

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, reverse=True)[:n]

modo.meshgeometry.collections._heapq._nsmallest()

type: builtin_function_or_method

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable)[:n]

modo.meshgeometry.collections._heapq._siftdown

type: function

file: .\Lib\heapq.py

modo.meshgeometry.collections._heapq._siftup

type: function

file: .\Lib\heapq.py

modo.meshgeometry.collections._heapq.bisect

type: module

doc: Bisection algorithms.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\bisect.pyc

modo.meshgeometry.collections._heapq.bisect.bisect()

type: builtin_function_or_method

doc: Alias for bisect_right().

modo.meshgeometry.collections._heapq.bisect.bisect_left()

type: builtin_function_or_method

doc: bisect_left(a, x[, lo[, hi]]) -> index Return the index where to insert item x in list a, assuming a is sorted. The return value i is such that all e in a[:i] have e < x, and all e in a[i:] have e >= x. So if x already appears in the list, i points just before the leftmost x already there. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.meshgeometry.collections._heapq.bisect.bisect_right()

type: builtin_function_or_method

doc: bisect_right(a, x[, lo[, hi]]) -> index Return the index where to insert item x in list a, assuming a is sorted. The return value i is such that all e in a[:i] have e <= x, and all e in a[i:] have e > x. So if x already appears in the list, i points just beyond the rightmost x already there Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.meshgeometry.collections._heapq.bisect.insort()

type: builtin_function_or_method

doc: Alias for insort_right().

modo.meshgeometry.collections._heapq.bisect.insort_left()

type: builtin_function_or_method

doc: insort_left(a, x[, lo[, hi]]) Insert item x in list a, and keep it sorted assuming a is sorted. If x is already in a, insert it to the left of the leftmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.meshgeometry.collections._heapq.bisect.insort_right()

type: builtin_function_or_method

doc: insort_right(a, x[, lo[, hi]]) Insert item x in list a, and keep it sorted assuming a is sorted. If x is already in a, insert it to the right of the rightmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.meshgeometry.collections._heapq.chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.meshgeometry.collections._heapq.chain contents:
  • modo.meshgeometry.collections._heapq.chain.__class__
  • modo.meshgeometry.collections._heapq.chain.__delattr__
  • modo.meshgeometry.collections._heapq.chain.__doc__
  • modo.meshgeometry.collections._heapq.chain.__format__
  • modo.meshgeometry.collections._heapq.chain.__getattribute__
  • modo.meshgeometry.collections._heapq.chain.__hash__
  • modo.meshgeometry.collections._heapq.chain.__init__
  • modo.meshgeometry.collections._heapq.chain.__iter__
  • modo.meshgeometry.collections._heapq.chain.__new__
  • modo.meshgeometry.collections._heapq.chain.__reduce__
  • modo.meshgeometry.collections._heapq.chain.__reduce_ex__
  • modo.meshgeometry.collections._heapq.chain.__repr__
  • modo.meshgeometry.collections._heapq.chain.__setattr__
  • modo.meshgeometry.collections._heapq.chain.__sizeof__
  • modo.meshgeometry.collections._heapq.chain.__str__
  • modo.meshgeometry.collections._heapq.chain.__subclasshook__
  • modo.meshgeometry.collections._heapq.chain.from_iterable
  • modo.meshgeometry.collections._heapq.chain.next

modo.meshgeometry.collections._heapq.chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.meshgeometry.collections._heapq.chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.collections._heapq.cmp_lt

type: function

file: .\Lib\heapq.py

modo.meshgeometry.collections._heapq.count

type: type

doc: count(start=0, step=1) --> count object Return a count object whose .next() method returns consecutive values. Equivalent to: def count(firstval=0, step=1): x = firstval while 1: yield x x += step

    modo.meshgeometry.collections._heapq.count contents:
  • modo.meshgeometry.collections._heapq.count.__class__
  • modo.meshgeometry.collections._heapq.count.__delattr__
  • modo.meshgeometry.collections._heapq.count.__doc__
  • modo.meshgeometry.collections._heapq.count.__format__
  • modo.meshgeometry.collections._heapq.count.__getattribute__
  • modo.meshgeometry.collections._heapq.count.__hash__
  • modo.meshgeometry.collections._heapq.count.__init__
  • modo.meshgeometry.collections._heapq.count.__iter__
  • modo.meshgeometry.collections._heapq.count.__new__
  • modo.meshgeometry.collections._heapq.count.__reduce__
  • modo.meshgeometry.collections._heapq.count.__reduce_ex__
  • modo.meshgeometry.collections._heapq.count.__repr__
  • modo.meshgeometry.collections._heapq.count.__setattr__
  • modo.meshgeometry.collections._heapq.count.__sizeof__
  • modo.meshgeometry.collections._heapq.count.__str__
  • modo.meshgeometry.collections._heapq.count.__subclasshook__
  • modo.meshgeometry.collections._heapq.count.next

modo.meshgeometry.collections._heapq.count.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.collections._heapq.heapify()

type: builtin_function_or_method

doc: Transform list into a heap, in-place, in O(len(heap)) time.

modo.meshgeometry.collections._heapq.heappop()

type: builtin_function_or_method

doc: Pop the smallest item off the heap, maintaining the heap invariant.

modo.meshgeometry.collections._heapq.heappush()

type: builtin_function_or_method

doc: Push item onto heap, maintaining the heap invariant.

modo.meshgeometry.collections._heapq.heappushpop()

type: builtin_function_or_method

doc: Push item on the heap, then pop and return the smallest item from the heap. The combined action runs more efficiently than heappush() followed by a separate call to heappop().

modo.meshgeometry.collections._heapq.heapreplace()

type: builtin_function_or_method

doc: Pop and return the current smallest value, and add the new item. This is more efficient than heappop() followed by heappush(), and can be more appropriate when using a fixed-size heap. Note that the value returned may be larger than item! That constrains reasonable uses of this routine unless written as part of a conditional replacement: if item > heap[0]: item = heapreplace(heap, item)

modo.meshgeometry.collections._heapq.imap

type: type

doc: imap(func, *iterables) --> imap object Make an iterator that computes the function using arguments from each of the iterables. Like map() except that it returns an iterator instead of a list and that it stops when the shortest iterable is exhausted instead of filling in None for shorter iterables.

    modo.meshgeometry.collections._heapq.imap contents:
  • modo.meshgeometry.collections._heapq.imap.__class__
  • modo.meshgeometry.collections._heapq.imap.__delattr__
  • modo.meshgeometry.collections._heapq.imap.__doc__
  • modo.meshgeometry.collections._heapq.imap.__format__
  • modo.meshgeometry.collections._heapq.imap.__getattribute__
  • modo.meshgeometry.collections._heapq.imap.__hash__
  • modo.meshgeometry.collections._heapq.imap.__init__
  • modo.meshgeometry.collections._heapq.imap.__iter__
  • modo.meshgeometry.collections._heapq.imap.__new__
  • modo.meshgeometry.collections._heapq.imap.__reduce__
  • modo.meshgeometry.collections._heapq.imap.__reduce_ex__
  • modo.meshgeometry.collections._heapq.imap.__repr__
  • modo.meshgeometry.collections._heapq.imap.__setattr__
  • modo.meshgeometry.collections._heapq.imap.__sizeof__
  • modo.meshgeometry.collections._heapq.imap.__str__
  • modo.meshgeometry.collections._heapq.imap.__subclasshook__
  • modo.meshgeometry.collections._heapq.imap.next

modo.meshgeometry.collections._heapq.imap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.collections._heapq.islice

type: type

doc: islice(iterable, [start,] stop [, step]) --> islice object Return an iterator whose next() method returns selected values from an iterable. If start is specified, will skip all preceding elements; otherwise, start defaults to zero. Step defaults to one. If specified as another value, step determines how many values are skipped between successive calls. Works like a slice() on a list but returns an iterator.

    modo.meshgeometry.collections._heapq.islice contents:
  • modo.meshgeometry.collections._heapq.islice.__class__
  • modo.meshgeometry.collections._heapq.islice.__delattr__
  • modo.meshgeometry.collections._heapq.islice.__doc__
  • modo.meshgeometry.collections._heapq.islice.__format__
  • modo.meshgeometry.collections._heapq.islice.__getattribute__
  • modo.meshgeometry.collections._heapq.islice.__hash__
  • modo.meshgeometry.collections._heapq.islice.__init__
  • modo.meshgeometry.collections._heapq.islice.__iter__
  • modo.meshgeometry.collections._heapq.islice.__new__
  • modo.meshgeometry.collections._heapq.islice.__reduce__
  • modo.meshgeometry.collections._heapq.islice.__reduce_ex__
  • modo.meshgeometry.collections._heapq.islice.__repr__
  • modo.meshgeometry.collections._heapq.islice.__setattr__
  • modo.meshgeometry.collections._heapq.islice.__sizeof__
  • modo.meshgeometry.collections._heapq.islice.__str__
  • modo.meshgeometry.collections._heapq.islice.__subclasshook__
  • modo.meshgeometry.collections._heapq.islice.next

modo.meshgeometry.collections._heapq.islice.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.collections._heapq.itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.meshgeometry.collections._heapq.itemgetter contents:
  • modo.meshgeometry.collections._heapq.itemgetter.__call__
  • modo.meshgeometry.collections._heapq.itemgetter.__class__
  • modo.meshgeometry.collections._heapq.itemgetter.__delattr__
  • modo.meshgeometry.collections._heapq.itemgetter.__doc__
  • modo.meshgeometry.collections._heapq.itemgetter.__format__
  • modo.meshgeometry.collections._heapq.itemgetter.__getattribute__
  • modo.meshgeometry.collections._heapq.itemgetter.__hash__
  • modo.meshgeometry.collections._heapq.itemgetter.__init__
  • modo.meshgeometry.collections._heapq.itemgetter.__new__
  • modo.meshgeometry.collections._heapq.itemgetter.__reduce__
  • modo.meshgeometry.collections._heapq.itemgetter.__reduce_ex__
  • modo.meshgeometry.collections._heapq.itemgetter.__repr__
  • modo.meshgeometry.collections._heapq.itemgetter.__setattr__
  • modo.meshgeometry.collections._heapq.itemgetter.__sizeof__
  • modo.meshgeometry.collections._heapq.itemgetter.__str__
  • modo.meshgeometry.collections._heapq.itemgetter.__subclasshook__
modo.meshgeometry.collections._heapq.izip

type: type

doc: izip(iter1 [,iter2 [...]]) --> izip object Return a izip object whose .next() method returns a tuple where the i-th element comes from the i-th iterable argument. The .next() method continues until the shortest iterable in the argument sequence is exhausted and then it raises StopIteration. Works like the zip() function but consumes less memory by returning an iterator instead of a list.

    modo.meshgeometry.collections._heapq.izip contents:
  • modo.meshgeometry.collections._heapq.izip.__class__
  • modo.meshgeometry.collections._heapq.izip.__delattr__
  • modo.meshgeometry.collections._heapq.izip.__doc__
  • modo.meshgeometry.collections._heapq.izip.__format__
  • modo.meshgeometry.collections._heapq.izip.__getattribute__
  • modo.meshgeometry.collections._heapq.izip.__hash__
  • modo.meshgeometry.collections._heapq.izip.__init__
  • modo.meshgeometry.collections._heapq.izip.__iter__
  • modo.meshgeometry.collections._heapq.izip.__new__
  • modo.meshgeometry.collections._heapq.izip.__reduce__
  • modo.meshgeometry.collections._heapq.izip.__reduce_ex__
  • modo.meshgeometry.collections._heapq.izip.__repr__
  • modo.meshgeometry.collections._heapq.izip.__setattr__
  • modo.meshgeometry.collections._heapq.izip.__sizeof__
  • modo.meshgeometry.collections._heapq.izip.__str__
  • modo.meshgeometry.collections._heapq.izip.__subclasshook__
  • modo.meshgeometry.collections._heapq.izip.next

modo.meshgeometry.collections._heapq.izip.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.collections._heapq.merge

type: function

doc: Merge multiple sorted inputs into a single sorted output. Similar to sorted(itertools.chain(*iterables)) but returns a generator, does not pull the data into memory all at once, and assumes that each of the input streams is already sorted (smallest to largest). >>> list(merge([1,3,5,7], [0,2,4,8], [5,10,15,20], [], [25])) [0, 1, 2, 3, 4, 5, 5, 7, 8, 10, 15, 20, 25]

file: .\Lib\heapq.py

modo.meshgeometry.collections._heapq.nlargest

type: function

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, key=key, reverse=True)[:n]

file: .\Lib\heapq.py

modo.meshgeometry.collections._heapq.nsmallest

type: function

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable, key=key)[:n]

file: .\Lib\heapq.py

modo.meshgeometry.collections._heapq.repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.meshgeometry.collections._heapq.repeat contents:
  • modo.meshgeometry.collections._heapq.repeat.__class__
  • modo.meshgeometry.collections._heapq.repeat.__delattr__
  • modo.meshgeometry.collections._heapq.repeat.__doc__
  • modo.meshgeometry.collections._heapq.repeat.__format__
  • modo.meshgeometry.collections._heapq.repeat.__getattribute__
  • modo.meshgeometry.collections._heapq.repeat.__hash__
  • modo.meshgeometry.collections._heapq.repeat.__init__
  • modo.meshgeometry.collections._heapq.repeat.__iter__
  • modo.meshgeometry.collections._heapq.repeat.__length_hint__
  • modo.meshgeometry.collections._heapq.repeat.__new__
  • modo.meshgeometry.collections._heapq.repeat.__reduce__
  • modo.meshgeometry.collections._heapq.repeat.__reduce_ex__
  • modo.meshgeometry.collections._heapq.repeat.__repr__
  • modo.meshgeometry.collections._heapq.repeat.__setattr__
  • modo.meshgeometry.collections._heapq.repeat.__sizeof__
  • modo.meshgeometry.collections._heapq.repeat.__str__
  • modo.meshgeometry.collections._heapq.repeat.__subclasshook__
  • modo.meshgeometry.collections._heapq.repeat.next

modo.meshgeometry.collections._heapq.repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.collections._heapq.tee()

type: builtin_function_or_method

doc: tee(iterable, n=2) --> tuple of n independent iterators.

modo.meshgeometry.collections._iskeyword()

type: builtin_function_or_method

doc: x.__contains__(y) <==> y in x.

modo.meshgeometry.collections._itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.meshgeometry.collections._itemgetter contents:
  • modo.meshgeometry.collections._itemgetter.__call__
  • modo.meshgeometry.collections._itemgetter.__class__
  • modo.meshgeometry.collections._itemgetter.__delattr__
  • modo.meshgeometry.collections._itemgetter.__doc__
  • modo.meshgeometry.collections._itemgetter.__format__
  • modo.meshgeometry.collections._itemgetter.__getattribute__
  • modo.meshgeometry.collections._itemgetter.__hash__
  • modo.meshgeometry.collections._itemgetter.__init__
  • modo.meshgeometry.collections._itemgetter.__new__
  • modo.meshgeometry.collections._itemgetter.__reduce__
  • modo.meshgeometry.collections._itemgetter.__reduce_ex__
  • modo.meshgeometry.collections._itemgetter.__repr__
  • modo.meshgeometry.collections._itemgetter.__setattr__
  • modo.meshgeometry.collections._itemgetter.__sizeof__
  • modo.meshgeometry.collections._itemgetter.__str__
  • modo.meshgeometry.collections._itemgetter.__subclasshook__
modo.meshgeometry.collections._repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.meshgeometry.collections._repeat contents:
  • modo.meshgeometry.collections._repeat.__class__
  • modo.meshgeometry.collections._repeat.__delattr__
  • modo.meshgeometry.collections._repeat.__doc__
  • modo.meshgeometry.collections._repeat.__format__
  • modo.meshgeometry.collections._repeat.__getattribute__
  • modo.meshgeometry.collections._repeat.__hash__
  • modo.meshgeometry.collections._repeat.__init__
  • modo.meshgeometry.collections._repeat.__iter__
  • modo.meshgeometry.collections._repeat.__length_hint__
  • modo.meshgeometry.collections._repeat.__new__
  • modo.meshgeometry.collections._repeat.__reduce__
  • modo.meshgeometry.collections._repeat.__reduce_ex__
  • modo.meshgeometry.collections._repeat.__repr__
  • modo.meshgeometry.collections._repeat.__setattr__
  • modo.meshgeometry.collections._repeat.__sizeof__
  • modo.meshgeometry.collections._repeat.__str__
  • modo.meshgeometry.collections._repeat.__subclasshook__
  • modo.meshgeometry.collections._repeat.next

modo.meshgeometry.collections._repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.collections._starmap

type: type

doc: starmap(function, sequence) --> starmap object Return an iterator whose values are returned from the function evaluated with a argument tuple taken from the given sequence.

    modo.meshgeometry.collections._starmap contents:
  • modo.meshgeometry.collections._starmap.__class__
  • modo.meshgeometry.collections._starmap.__delattr__
  • modo.meshgeometry.collections._starmap.__doc__
  • modo.meshgeometry.collections._starmap.__format__
  • modo.meshgeometry.collections._starmap.__getattribute__
  • modo.meshgeometry.collections._starmap.__hash__
  • modo.meshgeometry.collections._starmap.__init__
  • modo.meshgeometry.collections._starmap.__iter__
  • modo.meshgeometry.collections._starmap.__new__
  • modo.meshgeometry.collections._starmap.__reduce__
  • modo.meshgeometry.collections._starmap.__reduce_ex__
  • modo.meshgeometry.collections._starmap.__repr__
  • modo.meshgeometry.collections._starmap.__setattr__
  • modo.meshgeometry.collections._starmap.__sizeof__
  • modo.meshgeometry.collections._starmap.__str__
  • modo.meshgeometry.collections._starmap.__subclasshook__
  • modo.meshgeometry.collections._starmap.next

modo.meshgeometry.collections._starmap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.collections._sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.meshgeometry.collections._sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.meshgeometry.collections._sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.meshgeometry.collections._sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.meshgeometry.collections._sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.collections._sys.api_version

type: int

modo.meshgeometry.collections._sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.collections._sys.byteorder

type: str

modo.meshgeometry.collections._sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.meshgeometry.collections._sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.meshgeometry.collections._sys.copyright

type: str

modo.meshgeometry.collections._sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.meshgeometry.collections._sys.dllhandle

type: long

modo.meshgeometry.collections._sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.meshgeometry.collections._sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.meshgeometry.collections._sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.meshgeometry.collections._sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.meshgeometry.collections._sys.exc_type

type: type

doc: Inappropriate argument type.

    modo.meshgeometry.collections._sys.exc_type contents:
  • modo.meshgeometry.collections._sys.exc_type.__class__
  • modo.meshgeometry.collections._sys.exc_type.__delattr__
  • modo.meshgeometry.collections._sys.exc_type.__dict__
  • modo.meshgeometry.collections._sys.exc_type.__doc__
  • modo.meshgeometry.collections._sys.exc_type.__format__
  • modo.meshgeometry.collections._sys.exc_type.__getattribute__
  • modo.meshgeometry.collections._sys.exc_type.__getitem__
  • modo.meshgeometry.collections._sys.exc_type.__getslice__
  • modo.meshgeometry.collections._sys.exc_type.__hash__
  • modo.meshgeometry.collections._sys.exc_type.__init__
  • modo.meshgeometry.collections._sys.exc_type.__new__
  • modo.meshgeometry.collections._sys.exc_type.__reduce__
  • modo.meshgeometry.collections._sys.exc_type.__reduce_ex__
  • modo.meshgeometry.collections._sys.exc_type.__repr__
  • modo.meshgeometry.collections._sys.exc_type.__setattr__
  • modo.meshgeometry.collections._sys.exc_type.__setstate__
  • modo.meshgeometry.collections._sys.exc_type.__sizeof__
  • modo.meshgeometry.collections._sys.exc_type.__str__
  • modo.meshgeometry.collections._sys.exc_type.__subclasshook__
  • modo.meshgeometry.collections._sys.exc_type.__unicode__
  • modo.meshgeometry.collections._sys.exc_type.args
  • modo.meshgeometry.collections._sys.exc_type.message

modo.meshgeometry.collections._sys.exc_type.args

type: getset_descriptor

modo.meshgeometry.collections._sys.exc_type.message

type: getset_descriptor

modo.meshgeometry.collections._sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.meshgeometry.collections._sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.meshgeometry.collections._sys.exec_prefix

type: str

modo.meshgeometry.collections._sys.executable

type: str

modo.meshgeometry.collections._sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.meshgeometry.collections._sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.meshgeometry.collections._sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.meshgeometry.collections._sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.meshgeometry.collections._sys.float_repr_style

type: str

modo.meshgeometry.collections._sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.meshgeometry.collections._sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.meshgeometry.collections._sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.meshgeometry.collections._sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.meshgeometry.collections._sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.meshgeometry.collections._sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.meshgeometry.collections._sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.meshgeometry.collections._sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.meshgeometry.collections._sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.meshgeometry.collections._sys.hexversion

type: int

modo.meshgeometry.collections._sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.meshgeometry.collections._sys.maxint

type: int

modo.meshgeometry.collections._sys.maxsize

type: long

modo.meshgeometry.collections._sys.maxunicode

type: int

modo.meshgeometry.collections._sys.meta_path

type: list
modo.meshgeometry.collections._sys.modules type: dict

modo.meshgeometry.collections._sys.modules.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.meshgeometry.collections._sys.modules.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.meshgeometry.collections._sys.modules.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.meshgeometry.collections._sys.modules.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.collections._sys.modules.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.collections._sys.modules.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.meshgeometry.collections._sys.modules.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.meshgeometry.collections._sys.modules.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.meshgeometry.collections._sys.modules.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.meshgeometry.collections._sys.modules.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.meshgeometry.collections._sys.modules.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.meshgeometry.collections._sys.modules.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.meshgeometry.collections._sys.modules.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.meshgeometry.collections._sys.modules.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.meshgeometry.collections._sys.modules.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.meshgeometry.collections._sys.modules.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.meshgeometry.collections._sys.modules.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.meshgeometry.collections._sys.modules.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.meshgeometry.collections._sys.path

type: list

modo.meshgeometry.collections._sys.path_hooks

type: list
modo.meshgeometry.collections._sys.path_importer_cache type: dict

modo.meshgeometry.collections._sys.path_importer_cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.meshgeometry.collections._sys.path_importer_cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.meshgeometry.collections._sys.path_importer_cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.meshgeometry.collections._sys.path_importer_cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.collections._sys.path_importer_cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.collections._sys.path_importer_cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.meshgeometry.collections._sys.path_importer_cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.meshgeometry.collections._sys.path_importer_cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.meshgeometry.collections._sys.path_importer_cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.meshgeometry.collections._sys.path_importer_cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.meshgeometry.collections._sys.path_importer_cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.meshgeometry.collections._sys.path_importer_cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.meshgeometry.collections._sys.path_importer_cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.meshgeometry.collections._sys.path_importer_cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.meshgeometry.collections._sys.path_importer_cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.meshgeometry.collections._sys.path_importer_cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.meshgeometry.collections._sys.path_importer_cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.meshgeometry.collections._sys.path_importer_cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.meshgeometry.collections._sys.platform

type: str

modo.meshgeometry.collections._sys.prefix

type: str

modo.meshgeometry.collections._sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.meshgeometry.collections._sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.meshgeometry.collections._sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.meshgeometry.collections._sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.meshgeometry.collections._sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.meshgeometry.collections._sys.stderr

type: SESysStdErr

modo.meshgeometry.collections._sys.stdin

type: SESysStdIn

modo.meshgeometry.collections._sys.stdout

type: SESysStdOut

modo.meshgeometry.collections._sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.collections._sys.version

type: str

modo.meshgeometry.collections._sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.meshgeometry.collections._sys.warnoptions

type: list

modo.meshgeometry.collections._sys.winver

type: str

modo.meshgeometry.collections.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.Counter

type: type

doc: Dict subclass for counting hashable items. Sometimes called a bag or multiset. Elements are stored as dictionary keys and their counts are stored as dictionary values. >>> c = Counter('abcdeabcdabcaba') # count elements from a string >>> c.most_common(3) # three most common elements [('a', 5), ('b', 4), ('c', 3)] >>> sorted(c) # list all unique elements ['a', 'b', 'c', 'd', 'e'] >>> ''.join(sorted(c.elements())) # list elements with repetitions 'aaaaabbbbcccdde' >>> sum(c.values()) # total of all counts 15 >>> c['a'] # count of letter 'a' 5 >>> for elem in 'shazam': # update counts from an iterable ... c[elem] += 1 # by adding 1 to each element's count >>> c['a'] # now there are seven 'a' 7 >>> del c['b'] # remove all 'b' >>> c['b'] # now there are zero 'b' 0 >>> d = Counter('simsalabim') # make another counter >>> c.update(d) # add in the second counter >>> c['a'] # now there are nine 'a' 9 >>> c.clear() # empty the counter >>> c Counter() Note: If a count is set to zero or reduced to zero, it will remain in the counter until the entry is deleted or the counter is cleared: >>> c = Counter('aaabbc') >>> c['b'] -= 2 # reduce the count of 'b' by two >>> c.most_common() # 'b' is still in, but its count is zero [('a', 3), ('c', 1), ('b', 0)]

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.meshgeometry.collections.Counter.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.meshgeometry.collections.Counter.copy(self)

type: instancemethod

doc: Return a shallow copy.

file: .\Lib\collections.py

modo.meshgeometry.collections.Counter.elements(self)

type: instancemethod

doc: Iterator over elements repeating each as many times as its count. >>> c = Counter('ABCABC') >>> sorted(c.elements()) ['A', 'A', 'B', 'B', 'C', 'C'] # Knuth's example for prime factors of 1836: 2**2 * 3**3 * 17**1 >>> prime_factors = Counter({2: 2, 3: 3, 17: 1}) >>> product = 1 >>> for factor in prime_factors.elements(): # loop over factors ... product *= factor # and multiply them >>> product 1836 Note, if an element's count has been set to zero or is a negative number, elements() will ignore it.

file: .\Lib\collections.py

modo.meshgeometry.collections.Counter.fromkeys(cls,iterable,v)

type: instancemethod

file: .\Lib\collections.py

modo.meshgeometry.collections.Counter.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.collections.Counter.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.collections.Counter.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.meshgeometry.collections.Counter.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.meshgeometry.collections.Counter.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.meshgeometry.collections.Counter.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.meshgeometry.collections.Counter.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.meshgeometry.collections.Counter.most_common(self,n)

type: instancemethod

doc: List the n most common elements and their counts from the most common to the least. If n is None, then list all element counts. >>> Counter('abcdeabcdabcaba').most_common(3) [('a', 5), ('b', 4), ('c', 3)]

file: .\Lib\collections.py

modo.meshgeometry.collections.Counter.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.meshgeometry.collections.Counter.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.meshgeometry.collections.Counter.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.meshgeometry.collections.Counter.subtract(self,iterable)

type: instancemethod

doc: Like dict.update() but subtracts counts instead of replacing them. Counts can be reduced below zero. Both the inputs and outputs are allowed to contain zero and negative counts. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.subtract('witch') # subtract elements from another iterable >>> c.subtract(Counter('watch')) # subtract elements from another counter >>> c['h'] # 2 in which, minus 1 in witch, minus 1 in watch 0 >>> c['w'] # 1 in which, minus 1 in witch, minus 1 in watch -1

file: .\Lib\collections.py

modo.meshgeometry.collections.Counter.update(self,iterable)

type: instancemethod

doc: Like dict.update() but add counts instead of replacing them. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.update('witch') # add elements from another iterable >>> d = Counter('watch') >>> c.update(d) # add elements from another counter >>> c['h'] # four 'h' in which, witch, and watch 4

file: .\Lib\collections.py

modo.meshgeometry.collections.Counter.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.meshgeometry.collections.Counter.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.meshgeometry.collections.Counter.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.meshgeometry.collections.Counter.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.meshgeometry.collections.defaultdict

type: type

doc: defaultdict(default_factory) --> dict with default factory The default factory is called without arguments to produce a new value when a key is not present, in __getitem__ only. A defaultdict compares equal to a dict with the same items.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.meshgeometry.collections.defaultdict.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.meshgeometry.collections.defaultdict.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D.

modo.meshgeometry.collections.defaultdict.default_factory

type: member_descriptor

doc: Factory for default value called by __missing__().

modo.meshgeometry.collections.defaultdict.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.meshgeometry.collections.defaultdict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.collections.defaultdict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.collections.defaultdict.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.meshgeometry.collections.defaultdict.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.meshgeometry.collections.defaultdict.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.meshgeometry.collections.defaultdict.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.meshgeometry.collections.defaultdict.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.meshgeometry.collections.defaultdict.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.meshgeometry.collections.defaultdict.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.meshgeometry.collections.defaultdict.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.meshgeometry.collections.defaultdict.update()

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.meshgeometry.collections.defaultdict.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.meshgeometry.collections.defaultdict.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.meshgeometry.collections.defaultdict.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.meshgeometry.collections.defaultdict.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.meshgeometry.collections.deque

type: type

doc: deque(iterable[, maxlen]) --> deque object Build an ordered collection with optimized access from its endpoints.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.meshgeometry.collections.deque.append()

type: method_descriptor

doc: Add an element to the right side of the deque.

modo.meshgeometry.collections.deque.appendleft()

type: method_descriptor

doc: Add an element to the left side of the deque.

modo.meshgeometry.collections.deque.clear()

type: method_descriptor

doc: Remove all elements from the deque.

modo.meshgeometry.collections.deque.count()

type: method_descriptor

doc: D.count(value) -> integer -- return number of occurrences of value

modo.meshgeometry.collections.deque.extend()

type: method_descriptor

doc: Extend the right side of the deque with elements from the iterable

modo.meshgeometry.collections.deque.extendleft()

type: method_descriptor

doc: Extend the left side of the deque with elements from the iterable

modo.meshgeometry.collections.deque.maxlen

type: getset_descriptor

doc: maximum size of a deque or None if unbounded

modo.meshgeometry.collections.deque.pop()

type: method_descriptor

doc: Remove and return the rightmost element.

modo.meshgeometry.collections.deque.popleft()

type: method_descriptor

doc: Remove and return the leftmost element.

modo.meshgeometry.collections.deque.remove()

type: method_descriptor

doc: D.remove(value) -- remove first occurrence of value.

modo.meshgeometry.collections.deque.reverse()

type: method_descriptor

doc: D.reverse() -- reverse *IN PLACE*

modo.meshgeometry.collections.deque.rotate()

type: method_descriptor

doc: Rotate the deque n steps to the right (default n=1). If n is negative, rotates left.

modo.meshgeometry.collections.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.namedtuple

type: function

doc: Returns a new subclass of tuple with named fields. >>> Point = namedtuple('Point', 'x y') >>> Point.__doc__ # docstring for the new class 'Point(x, y)' >>> p = Point(11, y=22) # instantiate with positional args or keywords >>> p[0] + p[1] # indexable like a plain tuple 33 >>> x, y = p # unpack like a regular tuple >>> x, y (11, 22) >>> p.x + p.y # fields also accessable by name 33 >>> d = p._asdict() # convert to a dictionary >>> d['x'] 11 >>> Point(**d) # convert from a dictionary Point(x=11, y=22) >>> p._replace(x=100) # _replace() is like str.replace() but targets named fields Point(x=100, y=22)

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict

type: type

doc: Dictionary that remembers insertion order

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.meshgeometry.collections.OrderedDict._OrderedDict__marker

type: object

doc: The most base type

modo.meshgeometry.collections.OrderedDict._OrderedDict__update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.meshgeometry.collections.OrderedDict.clear(self)

type: instancemethod

doc: od.clear() -> None. Remove all items from od.

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.copy(self)

type: instancemethod

doc: od.copy() -> a shallow copy of od

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.fromkeys(cls,iterable,value)

type: instancemethod

doc: OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S. If not specified, the value defaults to None.

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.collections.OrderedDict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.collections.OrderedDict.items(self)

type: instancemethod

doc: od.items() -> list of (key, value) pairs in od

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.iteritems(self)

type: instancemethod

doc: od.iteritems -> an iterator over the (key, value) pairs in od

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.iterkeys(self)

type: instancemethod

doc: od.iterkeys() -> an iterator over the keys in od

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.itervalues(self)

type: instancemethod

doc: od.itervalues -> an iterator over the values in od

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.keys(self)

type: instancemethod

doc: od.keys() -> list of keys in od

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.pop(self,key,default)

type: instancemethod

doc: od.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.popitem(self,last)

type: instancemethod

doc: od.popitem() -> (k, v), return and remove a (key, value) pair. Pairs are returned in LIFO order if last is true or FIFO order if false.

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.setdefault(self,key,default)

type: instancemethod

doc: od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.meshgeometry.collections.OrderedDict.values(self)

type: instancemethod

doc: od.values() -> list of values in od

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.viewitems(self)

type: instancemethod

doc: od.viewitems() -> a set-like object providing a view on od's items

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.viewkeys(self)

type: instancemethod

doc: od.viewkeys() -> a set-like object providing a view on od's keys

file: .\Lib\collections.py

modo.meshgeometry.collections.OrderedDict.viewvalues(self)

type: instancemethod

doc: od.viewvalues() -> an object providing a view on od's values

file: .\Lib\collections.py

modo.meshgeometry.collections.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.collections.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.meshgeometry.item_type()

type: builtin_function_or_method

doc: integer type = ItemTypeLookup(string name)

modo.meshgeometry.MeshComponentContainer

type: type

doc: Base class for vertex, edge- and polygon containers to share common behaviour

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

    modo.meshgeometry.MeshComponentContainer contents:
  • modo.meshgeometry.MeshComponentContainer.__class__
  • modo.meshgeometry.MeshComponentContainer.__delattr__
  • modo.meshgeometry.MeshComponentContainer.__dict__
  • modo.meshgeometry.MeshComponentContainer.__doc__
  • modo.meshgeometry.MeshComponentContainer.__format__
  • modo.meshgeometry.MeshComponentContainer.__getattribute__
  • modo.meshgeometry.MeshComponentContainer.__hash__
  • modo.meshgeometry.MeshComponentContainer.__init__
  • modo.meshgeometry.MeshComponentContainer.__len__
  • modo.meshgeometry.MeshComponentContainer.__module__
  • modo.meshgeometry.MeshComponentContainer.__new__
  • modo.meshgeometry.MeshComponentContainer.__nonzero__
  • modo.meshgeometry.MeshComponentContainer.__reduce__
  • modo.meshgeometry.MeshComponentContainer.__reduce_ex__
  • modo.meshgeometry.MeshComponentContainer.__repr__
  • modo.meshgeometry.MeshComponentContainer.__setattr__
  • modo.meshgeometry.MeshComponentContainer.__sizeof__
  • modo.meshgeometry.MeshComponentContainer.__str__
  • modo.meshgeometry.MeshComponentContainer.__subclasshook__
  • modo.meshgeometry.MeshComponentContainer.__weakref__
  • modo.meshgeometry.MeshComponentContainer._getitem
  • modo.meshgeometry.MeshComponentContainer.internalMesh

modo.meshgeometry.MeshComponentContainer._getitem(self,index,cls)

type: instancemethod

doc: General access for angular brackets

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshComponentContainer.internalMesh

type: property

doc: :getter: returns the wrapped lx.object.Mesh object

modo.meshgeometry.MeshEdge

type: type

doc: Class representing an edge

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdge._accessor

type: property

modo.meshgeometry.MeshEdge._MeshEdge__apply_operator(self,func_name,operand)

type: instancemethod

doc: Helper function for operators

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdge.accessor

type: property

doc: :getter: Returns the internal shared EdgeAccessor object of the core SDK (lx.object.Edge)

modo.meshgeometry.MeshEdge.deselect(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdge.fromID(cls,id,geometry)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdge.fromIDs(cls,id1,id2,parent,mesh)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdge.fromVertices(cls,vertices,parent,mesh)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdge.id

type: property

doc: :getter: Returns the pointer ID of this edge

modo.meshgeometry.MeshEdge.polygons

type: property

doc: :getter: Returns the polygons connected to this edge

modo.meshgeometry.MeshEdge.select(self,replace)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdge.vertex_indices

type: property

doc: :getter: Returns the connected vertex indices as tuple

modo.meshgeometry.MeshEdge.vertices

type: property

doc: :getter: Returns the connected :class:`vertices` as tuple

modo.meshgeometry.MeshEdges

type: type

doc: Extension class of the Edge accessor lx.object.Edge that adds iteration methods. Note: Modo does not store edges by index, therefore they cannot be accessed by such. You can use the built-in python iterator however. :param mesh: Input mesh to obtain PointAccessor from :param parent: MeshGeometry parent object

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdges._getitem(self,index,cls)

type: instancemethod

doc: General access for angular brackets

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdges._MeshEdges__pollEdgeIDs(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdges._performSelectionOperation

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdges.enumerate(self,mode,visitor,monitor)

type: instancemethod

doc: Enumerate edges using a visitor :param int mode: lx.symbol.iMARK_ANY :param lxifc.Visitor visitor: Visitor class instance to use :param monitor: Optional monitor (progress bar) to display

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdges.fromVertices(self,vertices)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdges.internalMesh

type: property

doc: :getter: returns the wrapped lx.object.Mesh object

modo.meshgeometry.MeshEdges.select(self,edges,replace)

type: instancemethod

doc: Selects one or multiple edges of this mesh :param list or tuple edges: index, MeshEdge, or sequence of indices or MeshEdge objects. If None, the selection is cleared. :param bool replace: Clears the selection first

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshEdges.selected

type: property

doc: :getter: Returns the currently selected edges as tuple

modo.meshgeometry.MeshGeometry

type: type

doc: A class wrapped around lx.object.Mesh that provides access to geometry of a given Mesh Item :param item: Input item :type item: type lx.object.Item :param mode: Mode in which to access the mesh. Possible values: "write", "read", "deformed" :type mode: string. Note: References are always read only. :return: Instance of MeshGeometry :raises LookupError: If item was passed as string and could not be found in the scene :raises TypeError: If the passed item is not of type lx.object.Item :raises TypeError: If the passed item is not compatible with the mesh type example:: scene = modo.scene.current() # Get the selected mesh for mesh in scene.selectedByType("mesh")[:1]: # Print the number of vertices print len(mesh.geometry.vertices) # Print point position by index print mesh.geometry.vertices[4] # Set point position by index mesh.geometry.vertices[4] = (1,2,3) # Iterate all vertices and move them by 0.1 in x for point in mesh.geometry.vertices: point += (0.1, 0, 0) # Update to see mesh changes mesh.geometry.setMeshEdits() .. py:attribute:: vertices :rtype: :class:`MeshVertices` .. py:attribute:: edges :rtype: :class:`MeshEdges` .. py:attribute:: polygons :rtype: :class:`MeshPolygons` .. py:attribute:: vmaps :rtype: :class:`MeshMaps`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshGeometry._item

type: property

modo.meshgeometry.MeshGeometry._SEL_SVC

type: Selection

modo.meshgeometry.MeshGeometry._UNDO_SVC

type: Undo

modo.meshgeometry.MeshGeometry.accessMode

type: property

modo.meshgeometry.MeshGeometry.boundingBox

type: property

doc: Get the bounding box of this mesh :getter: Returns a tuple representing the two corners of the bounding box

modo.meshgeometry.MeshGeometry.getMeshCenter(self)

type: instancemethod

doc: :return: Center position of the bounding box

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshGeometry.internalMesh

type: property

doc: :getter: Returns the wrapped lx.object.Mesh object

modo.meshgeometry.MeshGeometry.numEdges

type: property

doc: :getter: returns the vertex count of this mesh

modo.meshgeometry.MeshGeometry.numPolygons

type: property

doc: :getter: returns the polygon count of this mesh

modo.meshgeometry.MeshGeometry.numVertices

type: property

doc: :getter: returns the vertex count of this mesh

modo.meshgeometry.MeshGeometry.setAccessMode(self,value,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshGeometry.setMeshEdits(self,editType)

type: instancemethod

doc: Updates mesh edits applying previous changes. :param lx.symbol.f_MESHEDIT_* editType: The type of change to set. Defaults to all.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps

type: type

doc: This module provides access to the various map types that a mesh holds. example:: # By index myMap = geo.vmaps[0] # From string myMap = geo.vmaps['MyMap'] # From string with wildcard myMap = geo.vmaps['MyMap*'] # Get the first morph map if any and change vertex 36 for morph in geo.vmaps.morphMaps[0:1]: morph[36] = (0, 0, 0) # Update changes on the mesh geo.setMeshEdits() Note: to remove a vertex map, use the Remove method of the accessor for now:: myMap.accessor.Remove()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps._getitem(self,index,cls)

type: instancemethod

doc: General access for angular brackets

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps._MeshMaps__classFromSymbol

type: function

doc: Returns the class that corresponds to the given symbol :param lx.symbol symbol: VMap symbol, for example lx.symbol.i_VMAP_MORPH :returns: Class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps._MeshMaps__poll(self,types_list)

type: instancemethod

doc: Enumerates and returns information about the mesh. :param list types_list: optional list of symbols (lx.symbol.i_VMAP_WEIGHT etc.) :returns: List of dictionaries with fields "name", "type_name", "ID" and "map_type"

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.meshgeometry.MeshMaps.addMap(self,mapType,name)

type: instancemethod

doc: Add a new map :arg string name: Name :returns: New map

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.addMorphMap(self,name,static)

type: instancemethod

doc: Add a morph map :arg string name: Name :arg bool static: Creates a static (absolute) morph map if true and relative one if false :returns MorphMap:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.addPickMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.addRGBAMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.addRGBMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.addSubdivMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.addUVMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.addVectorMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.addVertexNormalMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.addWeightMap(self,name,initValue)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.edgePickMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.getMapsByType(self,types_list)

type: instancemethod

doc: :param types_list: List of lx.symbol types. If it is None, all map types will be retrieved :type types_list: list :returns: tuple containing the requested map objects of this mesh

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.internalMesh

type: property

doc: :getter: returns the wrapped lx.object.Mesh object

modo.meshgeometry.MeshMaps.morphMaps

type: property

doc: :getter: Returns a list of morph maps

modo.meshgeometry.MeshMaps.pickMaps

type: property

doc: :getter: Returns a list of pick maps (aka selection sets)

modo.meshgeometry.MeshMaps.rgbaMaps

type: property

doc: :getter: Returns a list of RGBA maps

modo.meshgeometry.MeshMaps.rgbMaps

type: property

doc: :getter: Returns a list of RGB maps

modo.meshgeometry.MeshMaps.tangentBasisMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshMaps.uvMaps

type: property

doc: :getter: Returns a list of uv maps

modo.meshgeometry.MeshMaps.weightMaps

type: property

doc: :getter: Returns a list of weight maps

modo.meshgeometry.MeshPolygon

type: type

doc: Class wrapped around lx.object.Polygon for polygon access.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon._accessor

type: property

modo.meshgeometry.MeshPolygon._MeshPolygon__apply_operator(self,func_name,operand)

type: instancemethod

doc: Helper function for operators

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon._MeshPolygon__lookupUVMap(self,uvmap)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon._performSelectionOperation(self,operation)

type: instancemethod

doc: :param basestring operation: 'add', 'replace' or 'deselect'

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.accessor

type: property

doc: :getter: Returns the internal shared PolygonAccessor object of the core SDK (lx.object.Polygon)

modo.meshgeometry.MeshPolygon.area

type: property

doc: :getter: Returns the area of this polygon

modo.meshgeometry.MeshPolygon.deselect(self)

type: instancemethod

doc: Deselects this polygon

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.edges

type: property

doc: :getter: Returns the :class:`edges` connected to this polygon

modo.meshgeometry.MeshPolygon.fromID(cls,ID,geometry)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.fromMesh(cls,index,geometry)

type: instancemethod

doc: Initializes a polygon from a given MeshGeometry object :param index: The polygon index to be obtained :type: int :param geometry: The geometry to obtain the polygon from :type: MeshGeometry :return: An instance of MeshPolygon

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.getIsland(self)

type: instancemethod

doc: Returns the all connected neighbour polygons found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.getTag(self,tagType)

type: instancemethod

doc: Gets a polygon tag :param basestring tagType: Any out of lx.symbol.i_POLYTAG_* :return: Value of the tag

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.getUV(self,vertex,uvmap)

type: instancemethod

doc: Get a UV value pair from a vertex specific to this polygon. :param UVMap uvmap: The UVMap to read the value from :vertex int or MeshVertex: Vertex to read the uv value pair for. Can be a vertex index or a MeshVertex object.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.id

type: property

doc: :getter: Returns the pointer ID of this polygon

modo.meshgeometry.MeshPolygon.index

type: property

doc: :getter: Returns the index of this polygon

modo.meshgeometry.MeshPolygon.iterTriangles(self,asIndices)

type: instancemethod

doc: :param bool asIndices: Indices are returned if True, MeshVertex instances if False :returns generator object: Tuples consisting of 3 vertices each

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.iterVertexNormals(self)

type: instancemethod

doc: Iterator for vertex normals :return: Generator object that returns a vertex normal per polygon vertex

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.materialTag

type: property

doc: :getter: Get the value of the material tag :setter: Set the value of the material tag, taking a string argument

modo.meshgeometry.MeshPolygon.neighbours

type: property

doc: :getter: Returns the neighbour polygons as tuple

modo.meshgeometry.MeshPolygon.normal

type: property

doc: :getter: Returns the normal of this polygon face

modo.meshgeometry.MeshPolygon.numTriangles(self,keepTriangles)

type: instancemethod

doc: :returns: The number of triangles on the polygon

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.numVertices

type: property

doc: :getter: Returns the number of vertices of this polygon

modo.meshgeometry.MeshPolygon.remove(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.select(self,replace)

type: instancemethod

doc: Selects this polygon :param bool replace: Deselects all polygons of this mesh before selecting

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.setTag(self,tagType,value)

type: instancemethod

doc: Sets a polygon tag :param basestring tagType: Any out of lx.symbol.i_POLYTAG_* :param value: Value to set

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.setUV(self,values,vertex,uvmap)

type: instancemethod

doc: Set a UV value pair for a vertex specific to this polygon. Splitting UVs off their surrounding connections can be done this way. :param tuple values: A tuple containing the two uv floats to be set :vertex int or MeshVertex: Vertex to write the uv value pair for. Can be a vertex index or a MeshVertex object. :param UVMap uvmap: The UVMap to write the value to. Will look for the first found UV map if None

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.tags(self)

type: instancemethod

doc: List tags of this polygon

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.triangles

type: property

doc: :getter : Returns all triangle vertices as tuple

modo.meshgeometry.MeshPolygon.vertexNormal(self,index)

type: instancemethod

doc: :param int index: Vertex index on the polygon :returns tuple: The normal of the vertex

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygon.vertices

type: property

doc: :getter: Returns the connected :class:`vertices` of the polygon

modo.meshgeometry.MeshPolygons

type: type

doc: Extension class of the Polygon accessor that adds iteration methods. The vertices of of individual vertices can be accessed through the built-in iterator function or angular brackets example:: mesh, = modo.scene.current().selectedByType("mesh") # Get the number of polygon print "Number of polygons: %i" % len(mesh.geometry.polygons) # Access the first polygon and print it's normal polygon = mesh.geometry.polygons[0] print polygon.normal # Iterates all polygons through a generator object and print it's vertices for polygon in mesh.geometry.polygons: print polygon.vertices

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons._getitem(self,index,cls)

type: instancemethod

doc: General access for angular brackets

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons._performSelectionOperation

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.accessor

type: property

doc: :getter: Returns the internal shared PolygonAccessor object of the core SDK (lx.object.Polygon)

modo.meshgeometry.MeshPolygons.addFromPointIndices(self,indices,reversed)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.enumerate(self,mode,visitor,monitor)

type: instancemethod

doc: Enumerate polygons using a visitor :param int mode: lx.symbol.iMARK_ANY :param lxifc.Visitor visitor: Visitor class instance to use :param monitor: Optional monitor (progress bar) to display

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.internalMesh

type: property

doc: :getter: returns the wrapped lx.object.Mesh object

modo.meshgeometry.MeshPolygons.iterByIndices(self,poly_list)

type: instancemethod

doc: Iterate over polygons of a given list of indices. Use this if you want to save memory for large meshes. :param poly_list: List of point indices to visit :return: Iterable MeshPolygon generator object example:: for polygon in mesh.geometry.polygons.iterByIndices([1,4,2]): print polygon

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.iterByType(self,polyType)

type: instancemethod

doc: :param string polyType: Value in FACE, CURV, BEZR, SUBD, SPCH, TEXT, PSUB, LINE :returns: Generator object for polygons of specified type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.iterCurves(self)

type: instancemethod

doc: This method currently broken, please use iterByType('CURV') instead :returns: Iterable for curve polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.iterFaces(self)

type: instancemethod

doc: :returns: Iterable for curve polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.iterLines(self)

type: instancemethod

doc: :returns: Iterable for line polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.iterPixarSubdivs(self)

type: instancemethod

doc: :returns: Iterable for pixar subdiv polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.iterSplinePatches(self)

type: instancemethod

doc: :returns: Iterable for spline patch polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.iterSubdivs(self)

type: instancemethod

doc: :returns: Iterable for subdiv polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.iterTexts(self)

type: instancemethod

doc: :returns: Iterable for text polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.new(self,vertices,reversed)

type: instancemethod

doc: Clockwise for normal forward, anti for backwards

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.select(self,polygons,replace)

type: instancemethod

doc: Selects one or multiple polygons of this mesh :param int, list or tuple polygons: index, MeshPolygon, or sequence of indices or MeshPolygon objects. If None, the selection is cleared. :param bool replace: Clears the selection first

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshPolygons.selected

type: property

doc: :getter: Returns the selected polygons as tuple

modo.meshgeometry.MeshVertex

type: type

doc: Class representing a single vertex example:: #Supports operators v1 = mesh.geometry.vertices[1] v2 = mesh.geometry.vertices[2] v1 += v2 v1 = v1 - v2

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertex._accessor

type: property

modo.meshgeometry.MeshVertex._MeshVertex__performSelectionOp(self,operation,polygon)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertex.accessor

type: property

doc: :getter: Returns the internal shared PointAccessor object of the core SDK (lx.object.Point)

modo.meshgeometry.MeshVertex.deselect(self)

type: instancemethod

doc: Deselects this vertex

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertex.fromId(cls,id,geometry)

type: instancemethod

doc: Initializes a vertex from a given MeshGeometry object :param int or long vertex: The index of the vertex to be obtained. If vertex is of type long, it will be looked up as pointer ID. :type: int :param geometry: The geometry to obtain the vertex from :type: MeshGeometry :return: An instance of MeshVertex

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertex.getUVs(self,uvmap)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertex.id

type: property

doc: :getter: Returns the pointer ID of this vertex

modo.meshgeometry.MeshVertex.index

type: property

doc: :getter: Returns the index of this vertex

modo.meshgeometry.MeshVertex.nextPointByVector(self,direction,minAlign)

type: instancemethod

doc: :param Vector3 direction: A start vector :param float minAlign: A threshold between -1.0 and 1.0. The smaller the value, the bigger the angle range that is considered. :returns MeshVertex: The vertex closest to the given vector direction

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertex.polygons

type: property

doc: :getter: Returns the connected polygons

modo.meshgeometry.MeshVertex.position

type: property

doc: Get or set the local position vector as tuple :getter: Returns position as a tuple :setter: Takes an Iterable as input to set the position from

modo.meshgeometry.MeshVertex.remove(self)

type: instancemethod

doc: Removes this vertex from the mesh

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertex.select(self,polygon,replace)

type: instancemethod

doc: Selects this vertex :param MeshPolygon polygon: Selects the vertex specific to this polygon, needed for UV selections :param bool replace: Clears the selection before selecting

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertex.setUVs(self,values,uvmap)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertex.vertices

type: property

doc: :getter: Returns the connected vertices

modo.meshgeometry.MeshVertex.x

type: property

doc: :getter: Returns the x position :setter: Takes a float value to set the x position from

modo.meshgeometry.MeshVertex.y

type: property

doc: :getter: Returns the y position :setter: Takes a float value to set the y position from

modo.meshgeometry.MeshVertex.z

type: property

doc: :getter: Returns the z position :setter: Takes a float value to set the z position from

modo.meshgeometry.MeshVertices

type: type

doc: Extension class of the point accessor that adds iteration methods. The individual vertex objects can be accessed through the built-in iterator function or angular brackets example:: # Get the vertex count print "Number of vertices: %i" % len(mesh.geometry.vertices) # Access first vertex print mesh.geometry.vertices[0] # Iterates all vertices through a generator object for vertex in mesh.geometry.vertices: print vertex :param mesh: Input mesh to obtain PointAccessor from :param parent: MeshGeometry parent object

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertices._getitem(self,index,cls)

type: instancemethod

doc: General access for angular brackets

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertices._vertexSelectionOperation

type: function

doc: :param int operation: 0=select(add), 1=select(replace), 2=deselect, 3=clear

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertices.enumerate(self,mode,visitor,monitor)

type: instancemethod

doc: Enumerate vertices using a visitor :param int mode: lx.symbol.iMARK_ANY :param lxifc.Visitor visitor: Visitor class instance to use :param monitor: Optional monitor (progress bar) to display

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertices.internalMesh

type: property

doc: :getter: returns the wrapped lx.object.Mesh object

modo.meshgeometry.MeshVertices.iterByList(self,vertex_list)

type: instancemethod

doc: Iterate over vertices of a given list of point indices. :return: Iterable MeshVertices generator object :param vertex_list: List of point indices to visit example:: # Iterate all vertices and move them by 0.1 in x for point in mesh.geometry.vertices.iterByList([1,3,6,7]): pos = list(point.Pos()) pos[0] += 0.1 point.SetPos(pos) # Update to see mesh changes mesh.geometry.setMeshEdits()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertices.new(self,position)

type: instancemethod

doc: Adds a new vertex :param tuple: Position :returns MeshVertex: New vertex object

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertices.remove(self,vertices)

type: instancemethod

doc: Removes a single vertex or a list of vertices :param int or list/tuple vertices: Vertices to remove

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertices.select(self,vertices,replace)

type: instancemethod

doc: Selects one or multiple vertices of this mesh :param int, list or tuple vertices: index, MeshVertex, or sequence of indices or MeshVertex objects. If None, the selection is cleared. :param bool replace: Clears the selection first

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MeshVertices.selected

type: property

doc: :getter: Returns the currently selected vertices (tuple)

modo.meshgeometry.MorphMap

type: type

doc: example:: # Get first morph map if exists for morph in geo.vmaps.morphMaps[:1]: # Set position for vertex 10 morph[10] = (1,2,3) # Update mesh geo.setMeshEdits()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MorphMap._accessor

type: property

modo.meshgeometry.MorphMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.meshgeometry.MorphMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MorphMap.fromMesh(cls)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MorphMap.getAbsolutePosition(self,index)

type: instancemethod

doc: Gets the absolute position instead of the relative position :param int index: Vertex index to read :returns tuple: position values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.MorphMap.id

type: property

modo.meshgeometry.MorphMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.meshgeometry.MorphMap.setAbsolutePosition(self,index,value)

type: instancemethod

doc: Sets the absolute position instead of the relative position :param int index: Vertex index to change :param tuple: xyz values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.mproperty

type: type

doc: Use this descriptor as a decorator in the same way that you would use 'property', but only apply it to module-level functions, and watch as your module gains properties!

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.meshgeometry.mproperty.deleter(self,delete)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.meshgeometry.mproperty.doc

type: member_descriptor

modo.meshgeometry.mproperty.fdel

type: member_descriptor

modo.meshgeometry.mproperty.fget

type: member_descriptor

modo.meshgeometry.mproperty.fset

type: member_descriptor

modo.meshgeometry.mproperty.getter(self,get)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.meshgeometry.mproperty.setter(self,set)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.meshgeometry.PickMap

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

    modo.meshgeometry.PickMap contents:
  • modo.meshgeometry.PickMap.__class__
  • modo.meshgeometry.PickMap.__delattr__
  • modo.meshgeometry.PickMap.__dict__
  • modo.meshgeometry.PickMap.__doc__
  • modo.meshgeometry.PickMap.__format__
  • modo.meshgeometry.PickMap.__getattr__
  • modo.meshgeometry.PickMap.__getattribute__
  • modo.meshgeometry.PickMap.__getitem__
  • modo.meshgeometry.PickMap.__hash__
  • modo.meshgeometry.PickMap.__init__
  • modo.meshgeometry.PickMap.__iter__
  • modo.meshgeometry.PickMap.__len__
  • modo.meshgeometry.PickMap.__module__
  • modo.meshgeometry.PickMap.__new__
  • modo.meshgeometry.PickMap.__nonzero__
  • modo.meshgeometry.PickMap.__reduce__
  • modo.meshgeometry.PickMap.__reduce_ex__
  • modo.meshgeometry.PickMap.__repr__
  • modo.meshgeometry.PickMap.__setattr__
  • modo.meshgeometry.PickMap.__setitem__
  • modo.meshgeometry.PickMap.__sizeof__
  • modo.meshgeometry.PickMap.__str__
  • modo.meshgeometry.PickMap.__subclasshook__
  • modo.meshgeometry.PickMap.__weakref__
  • modo.meshgeometry.PickMap._accessor
  • modo.meshgeometry.PickMap.accessor
  • modo.meshgeometry.PickMap.clear
  • modo.meshgeometry.PickMap.fromMesh
  • modo.meshgeometry.PickMap.id
  • modo.meshgeometry.PickMap.name

modo.meshgeometry.PickMap._accessor

type: property

modo.meshgeometry.PickMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.meshgeometry.PickMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.PickMap.fromMesh(cls)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.PickMap.id

type: property

modo.meshgeometry.PickMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.meshgeometry.RGBAMap

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

    modo.meshgeometry.RGBAMap contents:
  • modo.meshgeometry.RGBAMap.__class__
  • modo.meshgeometry.RGBAMap.__delattr__
  • modo.meshgeometry.RGBAMap.__dict__
  • modo.meshgeometry.RGBAMap.__doc__
  • modo.meshgeometry.RGBAMap.__format__
  • modo.meshgeometry.RGBAMap.__getattr__
  • modo.meshgeometry.RGBAMap.__getattribute__
  • modo.meshgeometry.RGBAMap.__getitem__
  • modo.meshgeometry.RGBAMap.__hash__
  • modo.meshgeometry.RGBAMap.__init__
  • modo.meshgeometry.RGBAMap.__iter__
  • modo.meshgeometry.RGBAMap.__len__
  • modo.meshgeometry.RGBAMap.__module__
  • modo.meshgeometry.RGBAMap.__new__
  • modo.meshgeometry.RGBAMap.__nonzero__
  • modo.meshgeometry.RGBAMap.__reduce__
  • modo.meshgeometry.RGBAMap.__reduce_ex__
  • modo.meshgeometry.RGBAMap.__repr__
  • modo.meshgeometry.RGBAMap.__setattr__
  • modo.meshgeometry.RGBAMap.__setitem__
  • modo.meshgeometry.RGBAMap.__sizeof__
  • modo.meshgeometry.RGBAMap.__str__
  • modo.meshgeometry.RGBAMap.__subclasshook__
  • modo.meshgeometry.RGBAMap.__weakref__
  • modo.meshgeometry.RGBAMap._accessor
  • modo.meshgeometry.RGBAMap.accessor
  • modo.meshgeometry.RGBAMap.clear
  • modo.meshgeometry.RGBAMap.fromMesh
  • modo.meshgeometry.RGBAMap.id
  • modo.meshgeometry.RGBAMap.name

modo.meshgeometry.RGBAMap._accessor

type: property

modo.meshgeometry.RGBAMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.meshgeometry.RGBAMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.RGBAMap.fromMesh(cls)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.RGBAMap.id

type: property

modo.meshgeometry.RGBAMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.meshgeometry.RGBMap

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

    modo.meshgeometry.RGBMap contents:
  • modo.meshgeometry.RGBMap.__class__
  • modo.meshgeometry.RGBMap.__delattr__
  • modo.meshgeometry.RGBMap.__dict__
  • modo.meshgeometry.RGBMap.__doc__
  • modo.meshgeometry.RGBMap.__format__
  • modo.meshgeometry.RGBMap.__getattr__
  • modo.meshgeometry.RGBMap.__getattribute__
  • modo.meshgeometry.RGBMap.__getitem__
  • modo.meshgeometry.RGBMap.__hash__
  • modo.meshgeometry.RGBMap.__init__
  • modo.meshgeometry.RGBMap.__iter__
  • modo.meshgeometry.RGBMap.__len__
  • modo.meshgeometry.RGBMap.__module__
  • modo.meshgeometry.RGBMap.__new__
  • modo.meshgeometry.RGBMap.__nonzero__
  • modo.meshgeometry.RGBMap.__reduce__
  • modo.meshgeometry.RGBMap.__reduce_ex__
  • modo.meshgeometry.RGBMap.__repr__
  • modo.meshgeometry.RGBMap.__setattr__
  • modo.meshgeometry.RGBMap.__setitem__
  • modo.meshgeometry.RGBMap.__sizeof__
  • modo.meshgeometry.RGBMap.__str__
  • modo.meshgeometry.RGBMap.__subclasshook__
  • modo.meshgeometry.RGBMap.__weakref__
  • modo.meshgeometry.RGBMap._accessor
  • modo.meshgeometry.RGBMap.accessor
  • modo.meshgeometry.RGBMap.clear
  • modo.meshgeometry.RGBMap.fromMesh
  • modo.meshgeometry.RGBMap.id
  • modo.meshgeometry.RGBMap.name

modo.meshgeometry.RGBMap._accessor

type: property

modo.meshgeometry.RGBMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.meshgeometry.RGBMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.RGBMap.fromMesh(cls)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.RGBMap.id

type: property

modo.meshgeometry.RGBMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.meshgeometry.SCENE_SVC

type: Scene

modo.meshgeometry.SEL_SVC

type: Selection

modo.meshgeometry.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.meshgeometry.util.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.meshgeometry.util.collections

type: module

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.meshgeometry.util.collections._abcoll

type: module

doc: Abstract Base Classes (ABCs) for collections, according to PEP 3119. DON'T USE THIS MODULE DIRECTLY! The classes here should be imported via collections; they are defined here only to alleviate certain bootstrapping issues. Unit tests are in test_collections.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll._hasattr

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.meshgeometry.util.collections._abcoll.ABCMeta

type: type

doc: Metaclass for defining Abstract Base Classes (ABCs). Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as 'virtual subclasses' -- these and their descendants will be considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won't show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via super()).

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\abc.pyc

    modo.meshgeometry.util.collections._abcoll.ABCMeta contents:
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__base__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__bases__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__basicsize__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__call__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__class__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__delattr__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__dict__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__dictoffset__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__doc__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__eq__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__flags__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__format__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__ge__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__getattribute__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__gt__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__hash__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__init__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__instancecheck__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__itemsize__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__le__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__lt__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__module__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__mro__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__name__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__ne__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__new__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__reduce__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__reduce_ex__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__repr__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__setattr__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__sizeof__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__str__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__subclasscheck__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__subclasses__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__subclasshook__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.__weakrefoffset__
  • modo.meshgeometry.util.collections._abcoll.ABCMeta._abc_invalidation_counter
  • modo.meshgeometry.util.collections._abcoll.ABCMeta._dump_registry
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.mro
  • modo.meshgeometry.util.collections._abcoll.ABCMeta.register

modo.meshgeometry.util.collections._abcoll.ABCMeta._abc_invalidation_counter

type: int

modo.meshgeometry.util.collections._abcoll.ABCMeta._dump_registry(cls,file)

type: instancemethod

doc: Debug helper to print the ABC registry.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.meshgeometry.util.collections._abcoll.ABCMeta.mro()

type: method_descriptor

doc: mro() -> list return a type's method resolution order

modo.meshgeometry.util.collections._abcoll.ABCMeta.register(cls,subclass)

type: instancemethod

doc: Register a virtual subclass of an ABC.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.meshgeometry.util.collections._abcoll.abstractmethod

type: function

doc: A decorator indicating abstract methods. Requires that the metaclass is ABCMeta or derived from it. A class that has a metaclass derived from ABCMeta cannot be instantiated unless all of its abstract methods are overridden. The abstract methods can be called using any of the normal 'super' call mechanisms. Usage: class C: __metaclass__ = ABCMeta @abstractmethod def my_abstract_method(self, ...): ...

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.meshgeometry.util.collections._abcoll.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._abcoll.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.meshgeometry.util.collections._abcoll.sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.meshgeometry.util.collections._abcoll.sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.meshgeometry.util.collections._abcoll.sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.meshgeometry.util.collections._abcoll.sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.util.collections._abcoll.sys.api_version

type: int

modo.meshgeometry.util.collections._abcoll.sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.util.collections._abcoll.sys.byteorder

type: str

modo.meshgeometry.util.collections._abcoll.sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.meshgeometry.util.collections._abcoll.sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.meshgeometry.util.collections._abcoll.sys.copyright

type: str

modo.meshgeometry.util.collections._abcoll.sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.meshgeometry.util.collections._abcoll.sys.dllhandle

type: long

modo.meshgeometry.util.collections._abcoll.sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.meshgeometry.util.collections._abcoll.sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.meshgeometry.util.collections._abcoll.sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.meshgeometry.util.collections._abcoll.sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.meshgeometry.util.collections._abcoll.sys.exc_type

type: type

doc: Inappropriate argument type.

modo.meshgeometry.util.collections._abcoll.sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.meshgeometry.util.collections._abcoll.sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.meshgeometry.util.collections._abcoll.sys.exec_prefix

type: str

modo.meshgeometry.util.collections._abcoll.sys.executable

type: str

modo.meshgeometry.util.collections._abcoll.sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.meshgeometry.util.collections._abcoll.sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.meshgeometry.util.collections._abcoll.sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.meshgeometry.util.collections._abcoll.sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.meshgeometry.util.collections._abcoll.sys.float_repr_style

type: str

modo.meshgeometry.util.collections._abcoll.sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.meshgeometry.util.collections._abcoll.sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.meshgeometry.util.collections._abcoll.sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.meshgeometry.util.collections._abcoll.sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.meshgeometry.util.collections._abcoll.sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.meshgeometry.util.collections._abcoll.sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.meshgeometry.util.collections._abcoll.sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.meshgeometry.util.collections._abcoll.sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.meshgeometry.util.collections._abcoll.sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.meshgeometry.util.collections._abcoll.sys.hexversion

type: int

modo.meshgeometry.util.collections._abcoll.sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.meshgeometry.util.collections._abcoll.sys.maxint

type: int

modo.meshgeometry.util.collections._abcoll.sys.maxsize

type: long

modo.meshgeometry.util.collections._abcoll.sys.maxunicode

type: int

modo.meshgeometry.util.collections._abcoll.sys.meta_path

type: list

modo.meshgeometry.util.collections._abcoll.sys.modules

type: dict

modo.meshgeometry.util.collections._abcoll.sys.path

type: list

modo.meshgeometry.util.collections._abcoll.sys.path_hooks

type: list

modo.meshgeometry.util.collections._abcoll.sys.path_importer_cache

type: dict

modo.meshgeometry.util.collections._abcoll.sys.platform

type: str

modo.meshgeometry.util.collections._abcoll.sys.prefix

type: str

modo.meshgeometry.util.collections._abcoll.sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.meshgeometry.util.collections._abcoll.sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.meshgeometry.util.collections._abcoll.sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.meshgeometry.util.collections._abcoll.sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.meshgeometry.util.collections._abcoll.sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.meshgeometry.util.collections._abcoll.sys.stderr

type: SESysStdErr

modo.meshgeometry.util.collections._abcoll.sys.stdin

type: SESysStdIn

modo.meshgeometry.util.collections._abcoll.sys.stdout

type: SESysStdOut

modo.meshgeometry.util.collections._abcoll.sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.util.collections._abcoll.sys.version

type: str

modo.meshgeometry.util.collections._abcoll.sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.meshgeometry.util.collections._abcoll.sys.warnoptions

type: list

modo.meshgeometry.util.collections._abcoll.sys.winver

type: str

modo.meshgeometry.util.collections._abcoll.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections._chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.meshgeometry.util.collections._chain contents:
  • modo.meshgeometry.util.collections._chain.__class__
  • modo.meshgeometry.util.collections._chain.__delattr__
  • modo.meshgeometry.util.collections._chain.__doc__
  • modo.meshgeometry.util.collections._chain.__format__
  • modo.meshgeometry.util.collections._chain.__getattribute__
  • modo.meshgeometry.util.collections._chain.__hash__
  • modo.meshgeometry.util.collections._chain.__init__
  • modo.meshgeometry.util.collections._chain.__iter__
  • modo.meshgeometry.util.collections._chain.__new__
  • modo.meshgeometry.util.collections._chain.__reduce__
  • modo.meshgeometry.util.collections._chain.__reduce_ex__
  • modo.meshgeometry.util.collections._chain.__repr__
  • modo.meshgeometry.util.collections._chain.__setattr__
  • modo.meshgeometry.util.collections._chain.__sizeof__
  • modo.meshgeometry.util.collections._chain.__str__
  • modo.meshgeometry.util.collections._chain.__subclasshook__
  • modo.meshgeometry.util.collections._chain.from_iterable
  • modo.meshgeometry.util.collections._chain.next

modo.meshgeometry.util.collections._chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.meshgeometry.util.collections._chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.util.collections._get_ident()

type: builtin_function_or_method

doc: get_ident() -> integer Return a non-zero integer that uniquely identifies the current thread amongst other threads that exist simultaneously. This may be used to identify per-thread resources. Even though on some platforms threads identities may appear to be allocated consecutive numbers starting at 1, this behavior should not be relied upon, and the number should be seen purely as a magic cookie. A thread's identity may be reused for another thread after it exits.

modo.meshgeometry.util.collections._heapq

type: module

doc: Heap queue algorithm (a.k.a. priority queue). Heaps are arrays for which a[k] <= a[2*k+1] and a[k] <= a[2*k+2] for all k, counting elements from 0. For the sake of comparison, non-existing elements are considered to be infinite. The interesting property of a heap is that a[0] is always its smallest element. Usage: heap = [] # creates an empty heap heappush(heap, item) # pushes a new item on the heap item = heappop(heap) # pops the smallest item from the heap item = heap[0] # smallest item on the heap without popping it heapify(x) # transforms list into a heap, in-place, in linear time item = heapreplace(heap, item) # pops and returns smallest item, and adds # new item; the heap size is unchanged Our API differs from textbook heap algorithms as follows: - We use 0-based indexing. This makes the relationship between the index for a node and the indexes for its children slightly less obvious, but is more suitable since Python uses 0-based indexing. - Our heappop() method returns the smallest item, not the largest. These two make it possible to view the heap as a regular Python list without surprises: heap[0] is the smallest item, and heap.sort() maintains the heap invariant!

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\heapq.pyc

modo.meshgeometry.util.collections._heapq._nlargest()

type: builtin_function_or_method

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, reverse=True)[:n]

modo.meshgeometry.util.collections._heapq._nsmallest()

type: builtin_function_or_method

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable)[:n]

modo.meshgeometry.util.collections._heapq._siftdown

type: function

file: .\Lib\heapq.py

modo.meshgeometry.util.collections._heapq._siftup

type: function

file: .\Lib\heapq.py

modo.meshgeometry.util.collections._heapq.bisect

type: module

doc: Bisection algorithms.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\bisect.pyc

modo.meshgeometry.util.collections._heapq.bisect.bisect()

type: builtin_function_or_method

doc: Alias for bisect_right().

modo.meshgeometry.util.collections._heapq.bisect.bisect_left()

type: builtin_function_or_method

doc: bisect_left(a, x[, lo[, hi]]) -> index Return the index where to insert item x in list a, assuming a is sorted. The return value i is such that all e in a[:i] have e < x, and all e in a[i:] have e >= x. So if x already appears in the list, i points just before the leftmost x already there. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.meshgeometry.util.collections._heapq.bisect.bisect_right()

type: builtin_function_or_method

doc: bisect_right(a, x[, lo[, hi]]) -> index Return the index where to insert item x in list a, assuming a is sorted. The return value i is such that all e in a[:i] have e <= x, and all e in a[i:] have e > x. So if x already appears in the list, i points just beyond the rightmost x already there Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.meshgeometry.util.collections._heapq.bisect.insort()

type: builtin_function_or_method

doc: Alias for insort_right().

modo.meshgeometry.util.collections._heapq.bisect.insort_left()

type: builtin_function_or_method

doc: insort_left(a, x[, lo[, hi]]) Insert item x in list a, and keep it sorted assuming a is sorted. If x is already in a, insert it to the left of the leftmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.meshgeometry.util.collections._heapq.bisect.insort_right()

type: builtin_function_or_method

doc: insort_right(a, x[, lo[, hi]]) Insert item x in list a, and keep it sorted assuming a is sorted. If x is already in a, insert it to the right of the rightmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.meshgeometry.util.collections._heapq.chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.meshgeometry.util.collections._heapq.chain contents:
  • modo.meshgeometry.util.collections._heapq.chain.__class__
  • modo.meshgeometry.util.collections._heapq.chain.__delattr__
  • modo.meshgeometry.util.collections._heapq.chain.__doc__
  • modo.meshgeometry.util.collections._heapq.chain.__format__
  • modo.meshgeometry.util.collections._heapq.chain.__getattribute__
  • modo.meshgeometry.util.collections._heapq.chain.__hash__
  • modo.meshgeometry.util.collections._heapq.chain.__init__
  • modo.meshgeometry.util.collections._heapq.chain.__iter__
  • modo.meshgeometry.util.collections._heapq.chain.__new__
  • modo.meshgeometry.util.collections._heapq.chain.__reduce__
  • modo.meshgeometry.util.collections._heapq.chain.__reduce_ex__
  • modo.meshgeometry.util.collections._heapq.chain.__repr__
  • modo.meshgeometry.util.collections._heapq.chain.__setattr__
  • modo.meshgeometry.util.collections._heapq.chain.__sizeof__
  • modo.meshgeometry.util.collections._heapq.chain.__str__
  • modo.meshgeometry.util.collections._heapq.chain.__subclasshook__
  • modo.meshgeometry.util.collections._heapq.chain.from_iterable
  • modo.meshgeometry.util.collections._heapq.chain.next

modo.meshgeometry.util.collections._heapq.chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.meshgeometry.util.collections._heapq.chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.util.collections._heapq.cmp_lt

type: function

file: .\Lib\heapq.py

modo.meshgeometry.util.collections._heapq.count

type: type

doc: count(start=0, step=1) --> count object Return a count object whose .next() method returns consecutive values. Equivalent to: def count(firstval=0, step=1): x = firstval while 1: yield x x += step

    modo.meshgeometry.util.collections._heapq.count contents:
  • modo.meshgeometry.util.collections._heapq.count.__class__
  • modo.meshgeometry.util.collections._heapq.count.__delattr__
  • modo.meshgeometry.util.collections._heapq.count.__doc__
  • modo.meshgeometry.util.collections._heapq.count.__format__
  • modo.meshgeometry.util.collections._heapq.count.__getattribute__
  • modo.meshgeometry.util.collections._heapq.count.__hash__
  • modo.meshgeometry.util.collections._heapq.count.__init__
  • modo.meshgeometry.util.collections._heapq.count.__iter__
  • modo.meshgeometry.util.collections._heapq.count.__new__
  • modo.meshgeometry.util.collections._heapq.count.__reduce__
  • modo.meshgeometry.util.collections._heapq.count.__reduce_ex__
  • modo.meshgeometry.util.collections._heapq.count.__repr__
  • modo.meshgeometry.util.collections._heapq.count.__setattr__
  • modo.meshgeometry.util.collections._heapq.count.__sizeof__
  • modo.meshgeometry.util.collections._heapq.count.__str__
  • modo.meshgeometry.util.collections._heapq.count.__subclasshook__
  • modo.meshgeometry.util.collections._heapq.count.next

modo.meshgeometry.util.collections._heapq.count.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.util.collections._heapq.heapify()

type: builtin_function_or_method

doc: Transform list into a heap, in-place, in O(len(heap)) time.

modo.meshgeometry.util.collections._heapq.heappop()

type: builtin_function_or_method

doc: Pop the smallest item off the heap, maintaining the heap invariant.

modo.meshgeometry.util.collections._heapq.heappush()

type: builtin_function_or_method

doc: Push item onto heap, maintaining the heap invariant.

modo.meshgeometry.util.collections._heapq.heappushpop()

type: builtin_function_or_method

doc: Push item on the heap, then pop and return the smallest item from the heap. The combined action runs more efficiently than heappush() followed by a separate call to heappop().

modo.meshgeometry.util.collections._heapq.heapreplace()

type: builtin_function_or_method

doc: Pop and return the current smallest value, and add the new item. This is more efficient than heappop() followed by heappush(), and can be more appropriate when using a fixed-size heap. Note that the value returned may be larger than item! That constrains reasonable uses of this routine unless written as part of a conditional replacement: if item > heap[0]: item = heapreplace(heap, item)

modo.meshgeometry.util.collections._heapq.imap

type: type

doc: imap(func, *iterables) --> imap object Make an iterator that computes the function using arguments from each of the iterables. Like map() except that it returns an iterator instead of a list and that it stops when the shortest iterable is exhausted instead of filling in None for shorter iterables.

    modo.meshgeometry.util.collections._heapq.imap contents:
  • modo.meshgeometry.util.collections._heapq.imap.__class__
  • modo.meshgeometry.util.collections._heapq.imap.__delattr__
  • modo.meshgeometry.util.collections._heapq.imap.__doc__
  • modo.meshgeometry.util.collections._heapq.imap.__format__
  • modo.meshgeometry.util.collections._heapq.imap.__getattribute__
  • modo.meshgeometry.util.collections._heapq.imap.__hash__
  • modo.meshgeometry.util.collections._heapq.imap.__init__
  • modo.meshgeometry.util.collections._heapq.imap.__iter__
  • modo.meshgeometry.util.collections._heapq.imap.__new__
  • modo.meshgeometry.util.collections._heapq.imap.__reduce__
  • modo.meshgeometry.util.collections._heapq.imap.__reduce_ex__
  • modo.meshgeometry.util.collections._heapq.imap.__repr__
  • modo.meshgeometry.util.collections._heapq.imap.__setattr__
  • modo.meshgeometry.util.collections._heapq.imap.__sizeof__
  • modo.meshgeometry.util.collections._heapq.imap.__str__
  • modo.meshgeometry.util.collections._heapq.imap.__subclasshook__
  • modo.meshgeometry.util.collections._heapq.imap.next

modo.meshgeometry.util.collections._heapq.imap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.util.collections._heapq.islice

type: type

doc: islice(iterable, [start,] stop [, step]) --> islice object Return an iterator whose next() method returns selected values from an iterable. If start is specified, will skip all preceding elements; otherwise, start defaults to zero. Step defaults to one. If specified as another value, step determines how many values are skipped between successive calls. Works like a slice() on a list but returns an iterator.

    modo.meshgeometry.util.collections._heapq.islice contents:
  • modo.meshgeometry.util.collections._heapq.islice.__class__
  • modo.meshgeometry.util.collections._heapq.islice.__delattr__
  • modo.meshgeometry.util.collections._heapq.islice.__doc__
  • modo.meshgeometry.util.collections._heapq.islice.__format__
  • modo.meshgeometry.util.collections._heapq.islice.__getattribute__
  • modo.meshgeometry.util.collections._heapq.islice.__hash__
  • modo.meshgeometry.util.collections._heapq.islice.__init__
  • modo.meshgeometry.util.collections._heapq.islice.__iter__
  • modo.meshgeometry.util.collections._heapq.islice.__new__
  • modo.meshgeometry.util.collections._heapq.islice.__reduce__
  • modo.meshgeometry.util.collections._heapq.islice.__reduce_ex__
  • modo.meshgeometry.util.collections._heapq.islice.__repr__
  • modo.meshgeometry.util.collections._heapq.islice.__setattr__
  • modo.meshgeometry.util.collections._heapq.islice.__sizeof__
  • modo.meshgeometry.util.collections._heapq.islice.__str__
  • modo.meshgeometry.util.collections._heapq.islice.__subclasshook__
  • modo.meshgeometry.util.collections._heapq.islice.next

modo.meshgeometry.util.collections._heapq.islice.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.util.collections._heapq.itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.meshgeometry.util.collections._heapq.itemgetter contents:
  • modo.meshgeometry.util.collections._heapq.itemgetter.__call__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__class__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__delattr__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__doc__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__format__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__getattribute__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__hash__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__init__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__new__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__reduce__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__reduce_ex__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__repr__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__setattr__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__sizeof__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__str__
  • modo.meshgeometry.util.collections._heapq.itemgetter.__subclasshook__
modo.meshgeometry.util.collections._heapq.izip

type: type

doc: izip(iter1 [,iter2 [...]]) --> izip object Return a izip object whose .next() method returns a tuple where the i-th element comes from the i-th iterable argument. The .next() method continues until the shortest iterable in the argument sequence is exhausted and then it raises StopIteration. Works like the zip() function but consumes less memory by returning an iterator instead of a list.

    modo.meshgeometry.util.collections._heapq.izip contents:
  • modo.meshgeometry.util.collections._heapq.izip.__class__
  • modo.meshgeometry.util.collections._heapq.izip.__delattr__
  • modo.meshgeometry.util.collections._heapq.izip.__doc__
  • modo.meshgeometry.util.collections._heapq.izip.__format__
  • modo.meshgeometry.util.collections._heapq.izip.__getattribute__
  • modo.meshgeometry.util.collections._heapq.izip.__hash__
  • modo.meshgeometry.util.collections._heapq.izip.__init__
  • modo.meshgeometry.util.collections._heapq.izip.__iter__
  • modo.meshgeometry.util.collections._heapq.izip.__new__
  • modo.meshgeometry.util.collections._heapq.izip.__reduce__
  • modo.meshgeometry.util.collections._heapq.izip.__reduce_ex__
  • modo.meshgeometry.util.collections._heapq.izip.__repr__
  • modo.meshgeometry.util.collections._heapq.izip.__setattr__
  • modo.meshgeometry.util.collections._heapq.izip.__sizeof__
  • modo.meshgeometry.util.collections._heapq.izip.__str__
  • modo.meshgeometry.util.collections._heapq.izip.__subclasshook__
  • modo.meshgeometry.util.collections._heapq.izip.next

modo.meshgeometry.util.collections._heapq.izip.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.util.collections._heapq.merge

type: function

doc: Merge multiple sorted inputs into a single sorted output. Similar to sorted(itertools.chain(*iterables)) but returns a generator, does not pull the data into memory all at once, and assumes that each of the input streams is already sorted (smallest to largest). >>> list(merge([1,3,5,7], [0,2,4,8], [5,10,15,20], [], [25])) [0, 1, 2, 3, 4, 5, 5, 7, 8, 10, 15, 20, 25]

file: .\Lib\heapq.py

modo.meshgeometry.util.collections._heapq.nlargest

type: function

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, key=key, reverse=True)[:n]

file: .\Lib\heapq.py

modo.meshgeometry.util.collections._heapq.nsmallest

type: function

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable, key=key)[:n]

file: .\Lib\heapq.py

modo.meshgeometry.util.collections._heapq.repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.meshgeometry.util.collections._heapq.repeat contents:
  • modo.meshgeometry.util.collections._heapq.repeat.__class__
  • modo.meshgeometry.util.collections._heapq.repeat.__delattr__
  • modo.meshgeometry.util.collections._heapq.repeat.__doc__
  • modo.meshgeometry.util.collections._heapq.repeat.__format__
  • modo.meshgeometry.util.collections._heapq.repeat.__getattribute__
  • modo.meshgeometry.util.collections._heapq.repeat.__hash__
  • modo.meshgeometry.util.collections._heapq.repeat.__init__
  • modo.meshgeometry.util.collections._heapq.repeat.__iter__
  • modo.meshgeometry.util.collections._heapq.repeat.__length_hint__
  • modo.meshgeometry.util.collections._heapq.repeat.__new__
  • modo.meshgeometry.util.collections._heapq.repeat.__reduce__
  • modo.meshgeometry.util.collections._heapq.repeat.__reduce_ex__
  • modo.meshgeometry.util.collections._heapq.repeat.__repr__
  • modo.meshgeometry.util.collections._heapq.repeat.__setattr__
  • modo.meshgeometry.util.collections._heapq.repeat.__sizeof__
  • modo.meshgeometry.util.collections._heapq.repeat.__str__
  • modo.meshgeometry.util.collections._heapq.repeat.__subclasshook__
  • modo.meshgeometry.util.collections._heapq.repeat.next

modo.meshgeometry.util.collections._heapq.repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.util.collections._heapq.tee()

type: builtin_function_or_method

doc: tee(iterable, n=2) --> tuple of n independent iterators.

modo.meshgeometry.util.collections._iskeyword()

type: builtin_function_or_method

doc: x.__contains__(y) <==> y in x.

modo.meshgeometry.util.collections._itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.meshgeometry.util.collections._itemgetter contents:
  • modo.meshgeometry.util.collections._itemgetter.__call__
  • modo.meshgeometry.util.collections._itemgetter.__class__
  • modo.meshgeometry.util.collections._itemgetter.__delattr__
  • modo.meshgeometry.util.collections._itemgetter.__doc__
  • modo.meshgeometry.util.collections._itemgetter.__format__
  • modo.meshgeometry.util.collections._itemgetter.__getattribute__
  • modo.meshgeometry.util.collections._itemgetter.__hash__
  • modo.meshgeometry.util.collections._itemgetter.__init__
  • modo.meshgeometry.util.collections._itemgetter.__new__
  • modo.meshgeometry.util.collections._itemgetter.__reduce__
  • modo.meshgeometry.util.collections._itemgetter.__reduce_ex__
  • modo.meshgeometry.util.collections._itemgetter.__repr__
  • modo.meshgeometry.util.collections._itemgetter.__setattr__
  • modo.meshgeometry.util.collections._itemgetter.__sizeof__
  • modo.meshgeometry.util.collections._itemgetter.__str__
  • modo.meshgeometry.util.collections._itemgetter.__subclasshook__
modo.meshgeometry.util.collections._repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.meshgeometry.util.collections._repeat contents:
  • modo.meshgeometry.util.collections._repeat.__class__
  • modo.meshgeometry.util.collections._repeat.__delattr__
  • modo.meshgeometry.util.collections._repeat.__doc__
  • modo.meshgeometry.util.collections._repeat.__format__
  • modo.meshgeometry.util.collections._repeat.__getattribute__
  • modo.meshgeometry.util.collections._repeat.__hash__
  • modo.meshgeometry.util.collections._repeat.__init__
  • modo.meshgeometry.util.collections._repeat.__iter__
  • modo.meshgeometry.util.collections._repeat.__length_hint__
  • modo.meshgeometry.util.collections._repeat.__new__
  • modo.meshgeometry.util.collections._repeat.__reduce__
  • modo.meshgeometry.util.collections._repeat.__reduce_ex__
  • modo.meshgeometry.util.collections._repeat.__repr__
  • modo.meshgeometry.util.collections._repeat.__setattr__
  • modo.meshgeometry.util.collections._repeat.__sizeof__
  • modo.meshgeometry.util.collections._repeat.__str__
  • modo.meshgeometry.util.collections._repeat.__subclasshook__
  • modo.meshgeometry.util.collections._repeat.next

modo.meshgeometry.util.collections._repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.util.collections._starmap

type: type

doc: starmap(function, sequence) --> starmap object Return an iterator whose values are returned from the function evaluated with a argument tuple taken from the given sequence.

    modo.meshgeometry.util.collections._starmap contents:
  • modo.meshgeometry.util.collections._starmap.__class__
  • modo.meshgeometry.util.collections._starmap.__delattr__
  • modo.meshgeometry.util.collections._starmap.__doc__
  • modo.meshgeometry.util.collections._starmap.__format__
  • modo.meshgeometry.util.collections._starmap.__getattribute__
  • modo.meshgeometry.util.collections._starmap.__hash__
  • modo.meshgeometry.util.collections._starmap.__init__
  • modo.meshgeometry.util.collections._starmap.__iter__
  • modo.meshgeometry.util.collections._starmap.__new__
  • modo.meshgeometry.util.collections._starmap.__reduce__
  • modo.meshgeometry.util.collections._starmap.__reduce_ex__
  • modo.meshgeometry.util.collections._starmap.__repr__
  • modo.meshgeometry.util.collections._starmap.__setattr__
  • modo.meshgeometry.util.collections._starmap.__sizeof__
  • modo.meshgeometry.util.collections._starmap.__str__
  • modo.meshgeometry.util.collections._starmap.__subclasshook__
  • modo.meshgeometry.util.collections._starmap.next

modo.meshgeometry.util.collections._starmap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.util.collections._sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.meshgeometry.util.collections._sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.meshgeometry.util.collections._sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.meshgeometry.util.collections._sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.meshgeometry.util.collections._sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.util.collections._sys.api_version

type: int

modo.meshgeometry.util.collections._sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.util.collections._sys.byteorder

type: str

modo.meshgeometry.util.collections._sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.meshgeometry.util.collections._sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.meshgeometry.util.collections._sys.copyright

type: str

modo.meshgeometry.util.collections._sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.meshgeometry.util.collections._sys.dllhandle

type: long

modo.meshgeometry.util.collections._sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.meshgeometry.util.collections._sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.meshgeometry.util.collections._sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.meshgeometry.util.collections._sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.meshgeometry.util.collections._sys.exc_type

type: type

doc: Inappropriate argument type.

    modo.meshgeometry.util.collections._sys.exc_type contents:
  • modo.meshgeometry.util.collections._sys.exc_type.__class__
  • modo.meshgeometry.util.collections._sys.exc_type.__delattr__
  • modo.meshgeometry.util.collections._sys.exc_type.__dict__
  • modo.meshgeometry.util.collections._sys.exc_type.__doc__
  • modo.meshgeometry.util.collections._sys.exc_type.__format__
  • modo.meshgeometry.util.collections._sys.exc_type.__getattribute__
  • modo.meshgeometry.util.collections._sys.exc_type.__getitem__
  • modo.meshgeometry.util.collections._sys.exc_type.__getslice__
  • modo.meshgeometry.util.collections._sys.exc_type.__hash__
  • modo.meshgeometry.util.collections._sys.exc_type.__init__
  • modo.meshgeometry.util.collections._sys.exc_type.__new__
  • modo.meshgeometry.util.collections._sys.exc_type.__reduce__
  • modo.meshgeometry.util.collections._sys.exc_type.__reduce_ex__
  • modo.meshgeometry.util.collections._sys.exc_type.__repr__
  • modo.meshgeometry.util.collections._sys.exc_type.__setattr__
  • modo.meshgeometry.util.collections._sys.exc_type.__setstate__
  • modo.meshgeometry.util.collections._sys.exc_type.__sizeof__
  • modo.meshgeometry.util.collections._sys.exc_type.__str__
  • modo.meshgeometry.util.collections._sys.exc_type.__subclasshook__
  • modo.meshgeometry.util.collections._sys.exc_type.__unicode__
  • modo.meshgeometry.util.collections._sys.exc_type.args
  • modo.meshgeometry.util.collections._sys.exc_type.message

modo.meshgeometry.util.collections._sys.exc_type.args

type: getset_descriptor

modo.meshgeometry.util.collections._sys.exc_type.message

type: getset_descriptor

modo.meshgeometry.util.collections._sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.meshgeometry.util.collections._sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.meshgeometry.util.collections._sys.exec_prefix

type: str

modo.meshgeometry.util.collections._sys.executable

type: str

modo.meshgeometry.util.collections._sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.meshgeometry.util.collections._sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.meshgeometry.util.collections._sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.meshgeometry.util.collections._sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.meshgeometry.util.collections._sys.float_repr_style

type: str

modo.meshgeometry.util.collections._sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.meshgeometry.util.collections._sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.meshgeometry.util.collections._sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.meshgeometry.util.collections._sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.meshgeometry.util.collections._sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.meshgeometry.util.collections._sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.meshgeometry.util.collections._sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.meshgeometry.util.collections._sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.meshgeometry.util.collections._sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.meshgeometry.util.collections._sys.hexversion

type: int

modo.meshgeometry.util.collections._sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.meshgeometry.util.collections._sys.maxint

type: int

modo.meshgeometry.util.collections._sys.maxsize

type: long

modo.meshgeometry.util.collections._sys.maxunicode

type: int

modo.meshgeometry.util.collections._sys.meta_path

type: list
modo.meshgeometry.util.collections._sys.modules type: dict

modo.meshgeometry.util.collections._sys.modules.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.meshgeometry.util.collections._sys.modules.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.meshgeometry.util.collections._sys.modules.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.meshgeometry.util.collections._sys.modules.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.util.collections._sys.modules.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.util.collections._sys.modules.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.meshgeometry.util.collections._sys.modules.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.meshgeometry.util.collections._sys.modules.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.meshgeometry.util.collections._sys.modules.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.meshgeometry.util.collections._sys.modules.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.meshgeometry.util.collections._sys.modules.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.meshgeometry.util.collections._sys.modules.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.meshgeometry.util.collections._sys.modules.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.meshgeometry.util.collections._sys.modules.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.meshgeometry.util.collections._sys.modules.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.meshgeometry.util.collections._sys.modules.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.meshgeometry.util.collections._sys.modules.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.meshgeometry.util.collections._sys.modules.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.meshgeometry.util.collections._sys.path

type: list

modo.meshgeometry.util.collections._sys.path_hooks

type: list
modo.meshgeometry.util.collections._sys.path_importer_cache type: dict

modo.meshgeometry.util.collections._sys.path_importer_cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.meshgeometry.util.collections._sys.path_importer_cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.meshgeometry.util.collections._sys.path_importer_cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.meshgeometry.util.collections._sys.path_importer_cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.util.collections._sys.path_importer_cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.util.collections._sys.path_importer_cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.meshgeometry.util.collections._sys.path_importer_cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.meshgeometry.util.collections._sys.path_importer_cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.meshgeometry.util.collections._sys.path_importer_cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.meshgeometry.util.collections._sys.path_importer_cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.meshgeometry.util.collections._sys.path_importer_cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.meshgeometry.util.collections._sys.path_importer_cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.meshgeometry.util.collections._sys.path_importer_cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.meshgeometry.util.collections._sys.path_importer_cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.meshgeometry.util.collections._sys.path_importer_cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.meshgeometry.util.collections._sys.path_importer_cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.meshgeometry.util.collections._sys.path_importer_cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.meshgeometry.util.collections._sys.path_importer_cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.meshgeometry.util.collections._sys.platform

type: str

modo.meshgeometry.util.collections._sys.prefix

type: str

modo.meshgeometry.util.collections._sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.meshgeometry.util.collections._sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.meshgeometry.util.collections._sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.meshgeometry.util.collections._sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.meshgeometry.util.collections._sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.meshgeometry.util.collections._sys.stderr

type: SESysStdErr

modo.meshgeometry.util.collections._sys.stdin

type: SESysStdIn

modo.meshgeometry.util.collections._sys.stdout

type: SESysStdOut

modo.meshgeometry.util.collections._sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.util.collections._sys.version

type: str

modo.meshgeometry.util.collections._sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.meshgeometry.util.collections._sys.warnoptions

type: list

modo.meshgeometry.util.collections._sys.winver

type: str

modo.meshgeometry.util.collections.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.Counter

type: type

doc: Dict subclass for counting hashable items. Sometimes called a bag or multiset. Elements are stored as dictionary keys and their counts are stored as dictionary values. >>> c = Counter('abcdeabcdabcaba') # count elements from a string >>> c.most_common(3) # three most common elements [('a', 5), ('b', 4), ('c', 3)] >>> sorted(c) # list all unique elements ['a', 'b', 'c', 'd', 'e'] >>> ''.join(sorted(c.elements())) # list elements with repetitions 'aaaaabbbbcccdde' >>> sum(c.values()) # total of all counts 15 >>> c['a'] # count of letter 'a' 5 >>> for elem in 'shazam': # update counts from an iterable ... c[elem] += 1 # by adding 1 to each element's count >>> c['a'] # now there are seven 'a' 7 >>> del c['b'] # remove all 'b' >>> c['b'] # now there are zero 'b' 0 >>> d = Counter('simsalabim') # make another counter >>> c.update(d) # add in the second counter >>> c['a'] # now there are nine 'a' 9 >>> c.clear() # empty the counter >>> c Counter() Note: If a count is set to zero or reduced to zero, it will remain in the counter until the entry is deleted or the counter is cleared: >>> c = Counter('aaabbc') >>> c['b'] -= 2 # reduce the count of 'b' by two >>> c.most_common() # 'b' is still in, but its count is zero [('a', 3), ('c', 1), ('b', 0)]

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.meshgeometry.util.collections.Counter.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.meshgeometry.util.collections.Counter.copy(self)

type: instancemethod

doc: Return a shallow copy.

file: .\Lib\collections.py

modo.meshgeometry.util.collections.Counter.elements(self)

type: instancemethod

doc: Iterator over elements repeating each as many times as its count. >>> c = Counter('ABCABC') >>> sorted(c.elements()) ['A', 'A', 'B', 'B', 'C', 'C'] # Knuth's example for prime factors of 1836: 2**2 * 3**3 * 17**1 >>> prime_factors = Counter({2: 2, 3: 3, 17: 1}) >>> product = 1 >>> for factor in prime_factors.elements(): # loop over factors ... product *= factor # and multiply them >>> product 1836 Note, if an element's count has been set to zero or is a negative number, elements() will ignore it.

file: .\Lib\collections.py

modo.meshgeometry.util.collections.Counter.fromkeys(cls,iterable,v)

type: instancemethod

file: .\Lib\collections.py

modo.meshgeometry.util.collections.Counter.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.util.collections.Counter.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.util.collections.Counter.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.meshgeometry.util.collections.Counter.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.meshgeometry.util.collections.Counter.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.meshgeometry.util.collections.Counter.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.meshgeometry.util.collections.Counter.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.meshgeometry.util.collections.Counter.most_common(self,n)

type: instancemethod

doc: List the n most common elements and their counts from the most common to the least. If n is None, then list all element counts. >>> Counter('abcdeabcdabcaba').most_common(3) [('a', 5), ('b', 4), ('c', 3)]

file: .\Lib\collections.py

modo.meshgeometry.util.collections.Counter.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.meshgeometry.util.collections.Counter.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.meshgeometry.util.collections.Counter.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.meshgeometry.util.collections.Counter.subtract(self,iterable)

type: instancemethod

doc: Like dict.update() but subtracts counts instead of replacing them. Counts can be reduced below zero. Both the inputs and outputs are allowed to contain zero and negative counts. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.subtract('witch') # subtract elements from another iterable >>> c.subtract(Counter('watch')) # subtract elements from another counter >>> c['h'] # 2 in which, minus 1 in witch, minus 1 in watch 0 >>> c['w'] # 1 in which, minus 1 in witch, minus 1 in watch -1

file: .\Lib\collections.py

modo.meshgeometry.util.collections.Counter.update(self,iterable)

type: instancemethod

doc: Like dict.update() but add counts instead of replacing them. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.update('witch') # add elements from another iterable >>> d = Counter('watch') >>> c.update(d) # add elements from another counter >>> c['h'] # four 'h' in which, witch, and watch 4

file: .\Lib\collections.py

modo.meshgeometry.util.collections.Counter.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.meshgeometry.util.collections.Counter.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.meshgeometry.util.collections.Counter.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.meshgeometry.util.collections.Counter.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.meshgeometry.util.collections.defaultdict

type: type

doc: defaultdict(default_factory) --> dict with default factory The default factory is called without arguments to produce a new value when a key is not present, in __getitem__ only. A defaultdict compares equal to a dict with the same items.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.meshgeometry.util.collections.defaultdict.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.meshgeometry.util.collections.defaultdict.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D.

modo.meshgeometry.util.collections.defaultdict.default_factory

type: member_descriptor

doc: Factory for default value called by __missing__().

modo.meshgeometry.util.collections.defaultdict.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.meshgeometry.util.collections.defaultdict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.util.collections.defaultdict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.util.collections.defaultdict.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.meshgeometry.util.collections.defaultdict.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.meshgeometry.util.collections.defaultdict.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.meshgeometry.util.collections.defaultdict.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.meshgeometry.util.collections.defaultdict.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.meshgeometry.util.collections.defaultdict.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.meshgeometry.util.collections.defaultdict.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.meshgeometry.util.collections.defaultdict.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.meshgeometry.util.collections.defaultdict.update()

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.meshgeometry.util.collections.defaultdict.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.meshgeometry.util.collections.defaultdict.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.meshgeometry.util.collections.defaultdict.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.meshgeometry.util.collections.defaultdict.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.meshgeometry.util.collections.deque

type: type

doc: deque(iterable[, maxlen]) --> deque object Build an ordered collection with optimized access from its endpoints.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.meshgeometry.util.collections.deque.append()

type: method_descriptor

doc: Add an element to the right side of the deque.

modo.meshgeometry.util.collections.deque.appendleft()

type: method_descriptor

doc: Add an element to the left side of the deque.

modo.meshgeometry.util.collections.deque.clear()

type: method_descriptor

doc: Remove all elements from the deque.

modo.meshgeometry.util.collections.deque.count()

type: method_descriptor

doc: D.count(value) -> integer -- return number of occurrences of value

modo.meshgeometry.util.collections.deque.extend()

type: method_descriptor

doc: Extend the right side of the deque with elements from the iterable

modo.meshgeometry.util.collections.deque.extendleft()

type: method_descriptor

doc: Extend the left side of the deque with elements from the iterable

modo.meshgeometry.util.collections.deque.maxlen

type: getset_descriptor

doc: maximum size of a deque or None if unbounded

modo.meshgeometry.util.collections.deque.pop()

type: method_descriptor

doc: Remove and return the rightmost element.

modo.meshgeometry.util.collections.deque.popleft()

type: method_descriptor

doc: Remove and return the leftmost element.

modo.meshgeometry.util.collections.deque.remove()

type: method_descriptor

doc: D.remove(value) -- remove first occurrence of value.

modo.meshgeometry.util.collections.deque.reverse()

type: method_descriptor

doc: D.reverse() -- reverse *IN PLACE*

modo.meshgeometry.util.collections.deque.rotate()

type: method_descriptor

doc: Rotate the deque n steps to the right (default n=1). If n is negative, rotates left.

modo.meshgeometry.util.collections.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.namedtuple

type: function

doc: Returns a new subclass of tuple with named fields. >>> Point = namedtuple('Point', 'x y') >>> Point.__doc__ # docstring for the new class 'Point(x, y)' >>> p = Point(11, y=22) # instantiate with positional args or keywords >>> p[0] + p[1] # indexable like a plain tuple 33 >>> x, y = p # unpack like a regular tuple >>> x, y (11, 22) >>> p.x + p.y # fields also accessable by name 33 >>> d = p._asdict() # convert to a dictionary >>> d['x'] 11 >>> Point(**d) # convert from a dictionary Point(x=11, y=22) >>> p._replace(x=100) # _replace() is like str.replace() but targets named fields Point(x=100, y=22)

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict

type: type

doc: Dictionary that remembers insertion order

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.meshgeometry.util.collections.OrderedDict._OrderedDict__marker

type: object

doc: The most base type

modo.meshgeometry.util.collections.OrderedDict._OrderedDict__update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.meshgeometry.util.collections.OrderedDict.clear(self)

type: instancemethod

doc: od.clear() -> None. Remove all items from od.

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.copy(self)

type: instancemethod

doc: od.copy() -> a shallow copy of od

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.fromkeys(cls,iterable,value)

type: instancemethod

doc: OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S. If not specified, the value defaults to None.

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.util.collections.OrderedDict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.util.collections.OrderedDict.items(self)

type: instancemethod

doc: od.items() -> list of (key, value) pairs in od

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.iteritems(self)

type: instancemethod

doc: od.iteritems -> an iterator over the (key, value) pairs in od

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.iterkeys(self)

type: instancemethod

doc: od.iterkeys() -> an iterator over the keys in od

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.itervalues(self)

type: instancemethod

doc: od.itervalues -> an iterator over the values in od

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.keys(self)

type: instancemethod

doc: od.keys() -> list of keys in od

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.pop(self,key,default)

type: instancemethod

doc: od.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.popitem(self,last)

type: instancemethod

doc: od.popitem() -> (k, v), return and remove a (key, value) pair. Pairs are returned in LIFO order if last is true or FIFO order if false.

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.setdefault(self,key,default)

type: instancemethod

doc: od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.meshgeometry.util.collections.OrderedDict.values(self)

type: instancemethod

doc: od.values() -> list of values in od

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.viewitems(self)

type: instancemethod

doc: od.viewitems() -> a set-like object providing a view on od's items

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.viewkeys(self)

type: instancemethod

doc: od.viewkeys() -> a set-like object providing a view on od's keys

file: .\Lib\collections.py

modo.meshgeometry.util.collections.OrderedDict.viewvalues(self)

type: instancemethod

doc: od.viewvalues() -> an object providing a view on od's values

file: .\Lib\collections.py

modo.meshgeometry.util.collections.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.collections.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.ensureModoItem

type: function

doc: Decorator - ensures that the argument passed as the first parameter to a function is an instance of the modo :class:`Item` class. Should only only be used to decorate methods where the first argument is meant to be an item and ensures that if for any reason an item of either type lx.object.Item or lxu.object.Item gets passed to the method it will get wrapped as an modo.item.Item object before being used.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.meshgeometry.util.floatEquals

type: function

doc: Test if two floats are equal :returns bool:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.meshgeometry.util.functools

type: module

doc: functools.py - Tools for working with functions and callable objects

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

modo.meshgeometry.util.functools.cmp_to_key

type: function

doc: Convert a cmp= function into a key= function

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.meshgeometry.util.functools.partial

type: type

doc: partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

    modo.meshgeometry.util.functools.partial contents:
  • modo.meshgeometry.util.functools.partial.__call__
  • modo.meshgeometry.util.functools.partial.__class__
  • modo.meshgeometry.util.functools.partial.__delattr__
  • modo.meshgeometry.util.functools.partial.__dict__
  • modo.meshgeometry.util.functools.partial.__doc__
  • modo.meshgeometry.util.functools.partial.__format__
  • modo.meshgeometry.util.functools.partial.__getattribute__
  • modo.meshgeometry.util.functools.partial.__hash__
  • modo.meshgeometry.util.functools.partial.__init__
  • modo.meshgeometry.util.functools.partial.__new__
  • modo.meshgeometry.util.functools.partial.__reduce__
  • modo.meshgeometry.util.functools.partial.__reduce_ex__
  • modo.meshgeometry.util.functools.partial.__repr__
  • modo.meshgeometry.util.functools.partial.__setattr__
  • modo.meshgeometry.util.functools.partial.__setstate__
  • modo.meshgeometry.util.functools.partial.__sizeof__
  • modo.meshgeometry.util.functools.partial.__str__
  • modo.meshgeometry.util.functools.partial.__subclasshook__
  • modo.meshgeometry.util.functools.partial.args
  • modo.meshgeometry.util.functools.partial.func
  • modo.meshgeometry.util.functools.partial.keywords

modo.meshgeometry.util.functools.partial.args

type: member_descriptor

doc: tuple of arguments to future partial calls

modo.meshgeometry.util.functools.partial.func

type: member_descriptor

doc: function object to use in future partial calls

modo.meshgeometry.util.functools.partial.keywords

type: member_descriptor

doc: dictionary of keyword arguments to future partial calls

modo.meshgeometry.util.functools.reduce()

type: builtin_function_or_method

doc: reduce(function, sequence[, initial]) -> value Apply a function of two arguments cumulatively to the items of a sequence, from left to right, so as to reduce the sequence to a single value. For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates ((((1+2)+3)+4)+5). If initial is present, it is placed before the items of the sequence in the calculation, and serves as a default when the sequence is empty.

modo.meshgeometry.util.functools.total_ordering

type: function

doc: Class decorator that fills in missing ordering methods

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.meshgeometry.util.functools.update_wrapper

type: function

doc: Update a wrapper function to look like the wrapped function wrapper is the function to be updated wrapped is the original function assigned is a tuple naming the attributes assigned directly from the wrapped function to the wrapper function (defaults to functools.WRAPPER_ASSIGNMENTS) updated is a tuple naming the attributes of the wrapper that are updated with the corresponding attribute from the wrapped function (defaults to functools.WRAPPER_UPDATES)

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.meshgeometry.util.functools.WRAPPER_ASSIGNMENTS

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.util.functools.WRAPPER_UPDATES

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.util.functools.wraps

type: function

doc: Decorator factory to apply update_wrapper() to a wrapper function Returns a decorator that invokes update_wrapper() with the decorated function as the wrapper argument and the arguments to wraps() as the remaining arguments. Default arguments are as for update_wrapper(). This is a convenience function to simplify applying partial() to update_wrapper().

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.meshgeometry.util.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip

type: type

doc: Action Clip and Render pass item. :param item: either an item of type 'actionclip' or an item name/ID to lookup. :type item: an instance of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip._item

type: property

modo.meshgeometry.util.item.ActionClip._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.active

type: property

doc: Set or get the active state of the render pass. :getter: Returns the active state of the render pass. :rtype: bool :setter: Sets the active state of the renter pass :param state: active state. :type state: bool

modo.meshgeometry.util.item.ActionClip.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.ActionClip.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.ActionClip.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.ActionClip.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.ActionClip.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.enabled

type: property

doc: Get or set the enabled state of the render pass. :getter: Returns the enabled state. :rtype: bool :setter: Sets the enabled state of the render pass :param state: enabled state. :type state: bool

modo.meshgeometry.util.item.ActionClip.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.getValue(self,chan,time)

type: instancemethod

doc: Read a value set on a channel for this render pass. :param chan: the channel to read the value from. :type chan: modo.channel.Channel object :param time: the time (in seconds) to read the value for, defaults to 0.0. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.ActionClip.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.ActionClip.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.ActionClip.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.ActionClip.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.ActionClip.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.ActionClip.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.name

type: property

doc: Name of the render pass. :getter: Returns the name of the render pass :rtype: basestring :setter: Assigns a new name to the render pass :param name: new name for the render pass. :type name: basestring

modo.meshgeometry.util.item.ActionClip.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.ActionClip.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.ActionClip.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.ActionClip.passGroup

type: property

doc: The render pass group that the render pass belongs to. :getter: Returns the render pass group :rtype: modo.item.RenderPassGroup :setter: Sets the render pass group :param group: render pass group to parent to. :type group: modo.item.RenderPassGroup

modo.meshgeometry.util.item.ActionClip.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.scene

type: property

modo.meshgeometry.util.item.ActionClip.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.ActionClip.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.setValue(self,chan,value,time,key)

type: instancemethod

doc: Set a value on a channel for this render pass. :param chan: the channel to set the value on. :type chan: modo.channel.Channel object :param value: the value to set for the channel. :type value: any :param time: the time (in seconds) to set the value for, defaults to 0.0. :type time: float :param key: whether to set a key for the value or not, defaults to False. :param key: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ActionClip.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.ActionClip.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Actor

type: type

doc: Wrapper class for actor groups.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor._Actor__addClip(self,name,pose)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor._item

type: property

modo.meshgeometry.util.item.Actor._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.actions

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.meshgeometry.util.item.Actor.addAction(self,name)

type: instancemethod

doc: Adds an action to this actor Note: please avoid naming actions 'setup', 'edit' or 'scene' :returns ActionClip: ActionClip :param basestring name: Optional name for the action

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.addPose(self,name,activate)

type: instancemethod

doc: Adds a pose to this actor :returns ActionClip: ActionClip :param basestring name: Optional name for the pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.Actor.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.Actor.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.Actor.currentAction

type: property

doc: :getter: Returns the currently active action if any. None if no action is active :rtype: ActionClip

modo.meshgeometry.util.item.Actor.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.Actor.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.meshgeometry.util.item.Actor.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.meshgeometry.util.item.Actor.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.Actor.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.Actor.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.Actor.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.Actor.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.meshgeometry.util.item.Actor.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.Actor.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.Actor.items

type: property

doc: :getter: Returns a list of LocatorSuperType items that are connected to this action. :rtype: list

modo.meshgeometry.util.item.Actor.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.Actor.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.Actor.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.Actor.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.Actor.pose(self,poseName)

type: instancemethod

doc: Return a pose by name :param basestring poseName: Name of the pose to look up :returns: Pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.poses

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.meshgeometry.util.item.Actor.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.scene

type: property

modo.meshgeometry.util.item.Actor.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.Actor.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Actor.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Actor.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.meshgeometry.util.item.AreaLight

type: type

doc: Area light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Area Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. :param light: Optional area light item object (type lx.symbol.sITYPE_AREALIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid area light item selected. :raises TypeError: if the item passed as an argument isn't either an area light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight._item

type: property

modo.meshgeometry.util.item.AreaLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.AreaLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.AreaLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.AreaLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.AreaLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.AreaLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.AreaLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.AreaLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.AreaLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.AreaLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.AreaLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.meshgeometry.util.item.AreaLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.AreaLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.AreaLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.AreaLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.AreaLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.AreaLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.AreaLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.AreaLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.AreaLight.scene

type: property

modo.meshgeometry.util.item.AreaLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.AreaLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.AreaLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.AreaLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.AreaLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.meshgeometry.util.item.Camera

type: type

doc: Camera item class. Takes an optional 'camera' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'camera' or an item name or ID to look up. If no camera item is supplied as an argument an attempt will be made to wrap the most recently selected camera. :param camera: Optional camera item object (type lx.symbol.sITYPE_CAMERA) or string (item name or ID) to look up. :type camera: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid camera item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'camera' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the camera argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera._item

type: property

modo.meshgeometry.util.item.Camera._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.Camera.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.Camera.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.Camera.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.Camera.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.Camera.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.Camera.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.Camera.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.Camera.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.Camera.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.Camera.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.Camera.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.Camera.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.Camera.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.Camera.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Camera.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Camera.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Camera.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Camera.scene

type: property

modo.meshgeometry.util.item.Camera.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.Camera.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Camera.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Camera.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.Camera.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Channel

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Add a link between this channel and another. :param to_channel: The channel to link to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Channel.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Delete a link from the channel graph. :param to_channel: The channel the link is to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Channel.disconnectInput(self,other)

type: instancemethod

doc: Removes an input connection from another channel if it exists. :param Channel other: Other channel to disconnect from. If it is None, all input connections are removed.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Channel.envelope

type: property

doc: Returns the channel's animation envelope. :getter: Returns the channel's animation envelope. :rtype: modo.channel.Envelope :raises LookupError: if the channel isn't animated.

modo.meshgeometry.util.item.Channel.evalType

type: property

doc: Returns the evaluation type of a channel, which is the type of slot allocated in the eval state vector. This will return the "gradstack" exo-type for gradient channels. :getter: Returns the evaluation type of the channel :rtype: basestring

modo.meshgeometry.util.item.Channel.forward(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index forward of this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index forward of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Channel.fwdCount

type: property

doc: Returns the number of linked channels forward of this channel in this channel graph. :getter: Returns the number of linked channels forward of this channel in this channel graph. :rtype: int

modo.meshgeometry.util.item.Channel.fwdLinked

type: property

doc: Returns a list of the linked channels forward of this channel in the channel graph. :getter: Returns the forward channels in this item's channel graph. :rtype: list

modo.meshgeometry.util.item.Channel.get(self,time,action)

type: instancemethod

doc: Returns a channel's value for an action at a specific time. Defaults to reading the channel's evaluated value at the current time. :param time: Optional time in seconds to read the value at. :type time: float :param action: The action to read the value from. Defaults to None (evaluation). :type action: basestring :returns: the channel's value. :rtype: depends on the type of the channel being read.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Channel.graph

type: property

doc: The channel's channel graph. :getter: Returns the channel's channel graph. :rtype: lxu.object.ChannelGraph

modo.meshgeometry.util.item.Channel.index

type: property

doc: The channel's index. :getter: Returns the channel's index. :rtype: int

modo.meshgeometry.util.item.Channel.isAnimated

type: property

doc: Returns whether the channel is animated. :getter: Returns whether the channel is animated or not. :rtype: bool

modo.meshgeometry.util.item.Channel.item

type: property

doc: :getter: Returns the item that is associated with this channel :rtype: Item

modo.meshgeometry.util.item.Channel.name

type: property

doc: The channel's name. :getter: Returns the channel's name. :rtype: basestring

modo.meshgeometry.util.item.Channel.revCount

type: property

doc: Returns the number of linked channels that occur before this channel in the channel graph. :getter: Returns the number of linked channels that occur before this channel in the channel graph. :rtype: int

modo.meshgeometry.util.item.Channel.reverse(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index before this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index before of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Channel.revLinked

type: property

doc: Returns a list of the linked channels that appear before this channel in the channel graph. :getter: Returns the linked channels that appear before this channel in the channel graph. :rtype: list

modo.meshgeometry.util.item.Channel.set(self,value,time,key,action)

type: instancemethod

doc: Sets a channel's value for an action at a specific time. Defaults to setting the channel's value for the "edit" action and at the current time. :param value: The value to set for the channel. :type value: depends on the type of the channel :param time: optional time in seconds to set the value for. :type time: float :param key: Specifies whether to set a key for the channel. :type key: bool :param action: The action to set the value on. :type action: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Set a link's position (from index, to index) in the channel graph. :param from_index: The index in the channel graph for the current (from) channel. :type from_index: int :param to_channel: The to channel. :type to_channel: modo.channel.Channel :param to_index: the index in the channel graph for the 'to' channel. :type to_index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Channel.storageType

type: property

doc: Returns the storage type of the channel, which can be valid exo-type name for numeric and stored custom types or None if no storage type is found. :getter: Returns the channel storage type :rtype: basestring

modo.meshgeometry.util.item.Channel.type

type: property

doc: Returns the channel type. The numeric and gradient types can be keyframed. The return type is an int which translates to the following types: | 0: none | 1: integer | 2: float | 3: gradient | 4: storage | 5: eval :getter: Returns the channel type. :rtype: int

modo.meshgeometry.util.item.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.meshgeometry.util.item.ChannelRead contents:
  • modo.meshgeometry.util.item.ChannelRead.__class__
  • modo.meshgeometry.util.item.ChannelRead.__delattr__
  • modo.meshgeometry.util.item.ChannelRead.__dict__
  • modo.meshgeometry.util.item.ChannelRead.__doc__
  • modo.meshgeometry.util.item.ChannelRead.__format__
  • modo.meshgeometry.util.item.ChannelRead.__getattr__
  • modo.meshgeometry.util.item.ChannelRead.__getattribute__
  • modo.meshgeometry.util.item.ChannelRead.__hash__
  • modo.meshgeometry.util.item.ChannelRead.__init__
  • modo.meshgeometry.util.item.ChannelRead.__module__
  • modo.meshgeometry.util.item.ChannelRead.__new__
  • modo.meshgeometry.util.item.ChannelRead.__reduce__
  • modo.meshgeometry.util.item.ChannelRead.__reduce_ex__
  • modo.meshgeometry.util.item.ChannelRead.__repr__
  • modo.meshgeometry.util.item.ChannelRead.__setattr__
  • modo.meshgeometry.util.item.ChannelRead.__sizeof__
  • modo.meshgeometry.util.item.ChannelRead.__str__
  • modo.meshgeometry.util.item.ChannelRead.__subclasshook__
  • modo.meshgeometry.util.item.ChannelRead.__weakref__
  • modo.meshgeometry.util.item.ChannelRead.set

modo.meshgeometry.util.item.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.ChannelTriple

type: type

doc: Wrapper to allow setting and reading all three channels on a vector 'channel' at once :param basestring channelName: The channel name. eg 'diffCol' :param modo.item.Item item: The item the channel belongs to. :raises: LookUpError if no respective channel of the given name was found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.meshgeometry.util.item.ChannelTriple contents:
  • modo.meshgeometry.util.item.ChannelTriple.__class__
  • modo.meshgeometry.util.item.ChannelTriple.__delattr__
  • modo.meshgeometry.util.item.ChannelTriple.__dict__
  • modo.meshgeometry.util.item.ChannelTriple.__doc__
  • modo.meshgeometry.util.item.ChannelTriple.__format__
  • modo.meshgeometry.util.item.ChannelTriple.__getattribute__
  • modo.meshgeometry.util.item.ChannelTriple.__hash__
  • modo.meshgeometry.util.item.ChannelTriple.__init__
  • modo.meshgeometry.util.item.ChannelTriple.__module__
  • modo.meshgeometry.util.item.ChannelTriple.__new__
  • modo.meshgeometry.util.item.ChannelTriple.__reduce__
  • modo.meshgeometry.util.item.ChannelTriple.__reduce_ex__
  • modo.meshgeometry.util.item.ChannelTriple.__repr__
  • modo.meshgeometry.util.item.ChannelTriple.__setattr__
  • modo.meshgeometry.util.item.ChannelTriple.__sizeof__
  • modo.meshgeometry.util.item.ChannelTriple.__str__
  • modo.meshgeometry.util.item.ChannelTriple.__subclasshook__
  • modo.meshgeometry.util.item.ChannelTriple.__weakref__
  • modo.meshgeometry.util.item.ChannelTriple.get
  • modo.meshgeometry.util.item.ChannelTriple.set

modo.meshgeometry.util.item.ChannelTriple.get(self)

type: instancemethod

doc: Same arguments as Channel.get()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.ChannelTriple.set(self,values,time,action)

type: instancemethod

doc: Sets three values for the three channels at once :param float time: Time in seconds for the value to be set at (optional) :param basestring action: Action to set the value for (optional)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.meshgeometry.util.item.ChannelWrite contents:
  • modo.meshgeometry.util.item.ChannelWrite.__class__
  • modo.meshgeometry.util.item.ChannelWrite.__delattr__
  • modo.meshgeometry.util.item.ChannelWrite.__dict__
  • modo.meshgeometry.util.item.ChannelWrite.__doc__
  • modo.meshgeometry.util.item.ChannelWrite.__format__
  • modo.meshgeometry.util.item.ChannelWrite.__getattr__
  • modo.meshgeometry.util.item.ChannelWrite.__getattribute__
  • modo.meshgeometry.util.item.ChannelWrite.__hash__
  • modo.meshgeometry.util.item.ChannelWrite.__init__
  • modo.meshgeometry.util.item.ChannelWrite.__module__
  • modo.meshgeometry.util.item.ChannelWrite.__new__
  • modo.meshgeometry.util.item.ChannelWrite.__reduce__
  • modo.meshgeometry.util.item.ChannelWrite.__reduce_ex__
  • modo.meshgeometry.util.item.ChannelWrite.__repr__
  • modo.meshgeometry.util.item.ChannelWrite.__setattr__
  • modo.meshgeometry.util.item.ChannelWrite.__sizeof__
  • modo.meshgeometry.util.item.ChannelWrite.__str__
  • modo.meshgeometry.util.item.ChannelWrite.__subclasshook__
  • modo.meshgeometry.util.item.ChannelWrite.__weakref__
  • modo.meshgeometry.util.item.ChannelWrite.set

modo.meshgeometry.util.item.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.CylinderLight

type: type

doc: Cylinder light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Cylinder Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Cylinder Light item. :param light: Optional Cylinder light item object (type lx.symbol.sITYPE_CYLINDERLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid cylinder light item selected. :raises TypeError: if the item passed as an argument isn't either a cylinder light or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight._item

type: property

modo.meshgeometry.util.item.CylinderLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.CylinderLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.CylinderLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.CylinderLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.CylinderLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.CylinderLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.CylinderLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.CylinderLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.CylinderLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.CylinderLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.CylinderLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.meshgeometry.util.item.CylinderLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.CylinderLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.CylinderLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.CylinderLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.CylinderLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.CylinderLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.CylinderLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.CylinderLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.CylinderLight.scene

type: property

modo.meshgeometry.util.item.CylinderLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.CylinderLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.CylinderLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.CylinderLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.CylinderLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Deformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer._item

type: property

modo.meshgeometry.util.item.Deformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.Deformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.Deformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.Deformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.Deformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.Deformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.Deformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.Deformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.Deformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.Deformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.Deformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.meshgeometry.util.item.Deformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.Deformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.meshgeometry.util.item.Deformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.Deformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.Deformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.Deformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.scene

type: property

modo.meshgeometry.util.item.Deformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.Deformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Deformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Deformer.svc

type: Deformer

modo.meshgeometry.util.item.Deformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.DeformerGroup

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup._item

type: property

modo.meshgeometry.util.item.DeformerGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.DeformerGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.DeformerGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.DeformerGroup.connectInput(self,other)

type: instancemethod

doc: Connects an influence deformer into this deformGroup :param other:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.createJointLocator(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.DeformerGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.DeformerGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.DeformerGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.DeformerGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.DeformerGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.DeformerGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.DeformerGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.mesh(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.DeformerGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.DeformerGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.DeformerGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.DeformerGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.scene

type: property

modo.meshgeometry.util.item.DeformerGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.DeformerGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DeformerGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.DeformerGroup.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.DirectionalLight

type: type

doc: Directional light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Directional Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Directional Light item. :param light: Optional Directional light item object (type lx.symbol.sITYPE_SUNLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid directional light item selected. :raises TypeError: if the item passed as an argument isn't either a Directional light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight._item

type: property

modo.meshgeometry.util.item.DirectionalLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.DirectionalLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.DirectionalLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.DirectionalLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.DirectionalLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.DirectionalLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.DirectionalLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.DirectionalLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.DirectionalLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.DirectionalLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.DirectionalLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.meshgeometry.util.item.DirectionalLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.DirectionalLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.DirectionalLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.DirectionalLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.DirectionalLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.DirectionalLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.DirectionalLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.DirectionalLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.DirectionalLight.scene

type: property

modo.meshgeometry.util.item.DirectionalLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.DirectionalLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DirectionalLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.DirectionalLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.DirectionalLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.DomeLight

type: type

doc: Dome light item class Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Dome Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Dome Light item. :param light: Optional Dome light item object (type lx.symbol.sITYPE_DOMELIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Dome light item selected. :raises TypeError: if the item passed as an argument isn't either a Dome light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight._item

type: property

modo.meshgeometry.util.item.DomeLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.DomeLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.DomeLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.DomeLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.DomeLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.DomeLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.DomeLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.DomeLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.DomeLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.DomeLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.DomeLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.meshgeometry.util.item.DomeLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.DomeLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.DomeLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.DomeLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.DomeLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.DomeLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.DomeLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.DomeLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.DomeLight.scene

type: property

modo.meshgeometry.util.item.DomeLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.DomeLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.DomeLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.DomeLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.DomeLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Envelope

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Envelope.behavior

type: property

doc: gets/sets the behavior of times for both before the first keyframe and after the last keyframe in the envelope. :setter: Sets the envelope behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope behavior :rtype: int

modo.meshgeometry.util.item.Envelope.clear(self)

type: instancemethod

doc: Clears (removes all keys from) the envelope.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Envelope.interpolation

type: property

doc: Returns the interpolation setting for the envelope. Can be one of: | lx.symbol.iENVv_INTERP_CURVE | lx.symbol.iENVv_INTERP_LINEAR | lx.symbol.iENVv_INTERP_STEPPED :getter: Returns the interpolation setting for the envelope. :rtype: int

modo.meshgeometry.util.item.Envelope.isInt

type: property

doc: Returns whether the envelope is integer-valued type, if not it's a float type. :Getter: Returns True if the envelope is integer-valued type, False otherwise. :rtype: bool

modo.meshgeometry.util.item.Envelope.keyframes

type: property

doc: Returns a :class:`Keyframes` object that provides access to the keyframes set for the envelope and methods to manipulate them. :getter: Returns a :class:`Keyframes` object containing the keys for this envelope. :rtype: modo.channel.Keyframes

modo.meshgeometry.util.item.Envelope.postBehaviour

type: property

doc: gets/sets the behavior of times after the last keyframe in the envelope. :setter: Sets the envelope post behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope post behavior :rtype: int

modo.meshgeometry.util.item.Envelope.preBehaviour

type: property

doc: gets/sets the behavior of times before the first keyframe in the envelope. - **RESET** A default value, or may be just zero. - **CONSTANT** The value of the first or last keyframe. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **REPEAT** The values in the keyframe range repeating continuously. - **OSCILLATE** Like repeat, but the values run forwards and backward alternately. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **OFFSETREPEAT** Like repeat, but the values are offset in each cycle by the difference between the first and last keyframes. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **LINEAR** Linear interpolation from the slope at the nearest keyframe. - **NONE** Indicates that the envelope does not exist before or after the explicit keyframe range. This can be used by motion evaluation code to decide whether to use the envelope for a channel or to look up the parent envelope or default value. - **CONSTANT_KEEP_SLOPE** As for constant except that the slopes of the first or last keys are not changed. - **OSCILLATE_KEEP_SLOPE** As for oscillate except that the slopes of the first or last keys are not changed. - **OFFSETREPEAT_KEEP_SLOPE** As for offset repeat except that the slopes of the first or last keys are not changed. :setter: Sets the behavior :param behavior: the behaviour to set for the envelope. Can be one of: | lx.symbol.iENV_RESET | lx.symbol.iENV_CONSTANT | lx.symbol.iENV_REPEAT | lx.symbol.iENV_OSCILLATE | lx.symbol.iENV_OFFSETREPEAT | lx.symbol.iENV_LINEAR | lx.symbol.iENV_NONE | lx.symbol.iENV_CONSTANT_KEEP_SLOPE | lx.symbol.iENV_OSCILLATE_KEEP_SLOPE | lx.symbol.iENV_OFFSETREPEAT_KEEP_SLOPE :type behavior: int :getter: Returns envelope behavior :rtype: int

modo.meshgeometry.util.item.Envelope.value(self,time)

type: instancemethod

doc: Returns the value of the envelope evaluated at the specified time. If no time is explicitly provided the value of the envelope at the current time is returned :param time: time to evaluate envelope at. :type time: float :returns: value of the envelope :rtype: float for float type envelopes, int for integer-valued type envelopes

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer._item

type: property

modo.meshgeometry.util.item.GeneralInfluenceDeformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.GeneralInfluenceDeformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.GeneralInfluenceDeformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.GeneralInfluenceDeformer.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.GeneralInfluenceDeformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.GeneralInfluenceDeformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.GeneralInfluenceDeformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.GeneralInfluenceDeformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.GeneralInfluenceDeformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.GeneralInfluenceDeformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.GeneralInfluenceDeformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.mapName

type: property

doc: :getter: Returns the UI version of the map name as string

modo.meshgeometry.util.item.GeneralInfluenceDeformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.meshgeometry.util.item.GeneralInfluenceDeformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.GeneralInfluenceDeformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.meshgeometry.util.item.GeneralInfluenceDeformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.GeneralInfluenceDeformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.GeneralInfluenceDeformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.GeneralInfluenceDeformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.scene

type: property

modo.meshgeometry.util.item.GeneralInfluenceDeformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.GeneralInfluenceDeformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GeneralInfluenceDeformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.GeneralInfluenceDeformer.svc

type: Deformer

modo.meshgeometry.util.item.GeneralInfluenceDeformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Group

type: type

doc: A group item. Takes an optional 'groupItem' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group' or an item name or ID to look up. If no groupItem is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. 'gtype' can be any one of the built in group types by passing one of the built in type strings ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader'), an empty string for a general group or any other string to create a custom group type. :param groupItem: an optional group item (type lx.symbol.sITYPE_GROUP) or an item name/ID to look up. :type groupItem: an instance of lx.object.Item, lxu.object.item or modo.item.Item :param gtype: the group type. :type gtype: basestring :raises TypeError: if an item is supplied as the groupItem argument but is not of type lx.symbol.sITYPE_GROUP. :raises ValueError: if no groupItem argument is supplied and no valid group item is selected in the scene. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found. Note that the children() method derived from the Item object will only list child groups. To iterate the contained items, use the method items.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group._item

type: property

modo.meshgeometry.util.item.Group._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.Group.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.Group.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.Group.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.Group.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.meshgeometry.util.item.Group.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.meshgeometry.util.item.Group.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.Group.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.Group.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.Group.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.Group.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.meshgeometry.util.item.Group.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.Group.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.Group.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.meshgeometry.util.item.Group.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.Group.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.Group.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.Group.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.Group.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.scene

type: property

modo.meshgeometry.util.item.Group.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.Group.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Group.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Group.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.meshgeometry.util.item.GroupLocator

type: type

doc: Group locator item class. Takes an optional 'grploc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group locator' or an item name or ID to look up. If no grploc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param grploc: Optional group locator item object (type lx.symbol.sITYPE_GROUPLOCATOR) or string (item name or ID) to look up. :type grploc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid group locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'group locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the grploc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator._item

type: property

modo.meshgeometry.util.item.GroupLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.GroupLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.GroupLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.GroupLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.GroupLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.GroupLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.GroupLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.GroupLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.GroupLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.GroupLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.GroupLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.GroupLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.GroupLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.GroupLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.GroupLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.GroupLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.GroupLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.GroupLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.GroupLocator.scene

type: property

modo.meshgeometry.util.item.GroupLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.GroupLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.GroupLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.GroupLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.GroupLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Item

type: type

doc: Base item class Takes an optional lx.object.Item object as an argument. If none is provided (the default) then the most recently selected item is used. :param item: Optional item object to wrap. :type item: an instance of lx.object.Item or lxu.object.item :raises ValueError: if no item is passed as an argument and no valid items are currently selected. :raises LookupError: if a string (item name or ID) is passed as the item argument and no item with that name or ID cane be found in the scene. :raises TypeError: if the object passed as the 'item' argument isn't an instance of lx.object.Item.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item._item

type: property

modo.meshgeometry.util.item.Item._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.Item.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.Item.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.Item.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.Item.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.Item.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.Item.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.Item.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.Item.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.Item.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.Item.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.Item.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.Item.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.Item.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.Item.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.scene

type: property

modo.meshgeometry.util.item.Item.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.Item.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Item.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Item.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.ItemGraph

type: type

doc: Utility container class for quick access to ItemGraph compatible graphs :param item: Item to look up graph for :param ls.symbol.sGRAPH_* graphType: Graph to look up. Common ones are 'parent', 'deformers', 'groups', 'chanMods' :param bool reverse: Indices traverse the graph forwards if false or reverse if true

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ItemGraph._ItemGraph__toType

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ItemGraph.connectedItems

type: property

doc: :getter: Returns a dictionary that lists the input- and output items at once. :rtype: dictionary

modo.meshgeometry.util.item.ItemGraph.connectInput(self,other)

type: instancemethod

doc: Connects the given item as input. This function is called by the >> operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ItemGraph.disconnectInput(self,other)

type: instancemethod

doc: Removes the given item from the input connections if any. This function is called by the << operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ItemGraph.forward(self,index)

type: instancemethod

doc: :returns list: Items of the forward connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ItemGraph.item

type: property

doc: :getter: Returns the Item that this ItemGraph instance is bound to. :return type: Item

modo.meshgeometry.util.item.ItemGraph.reverse(self,index)

type: instancemethod

doc: :returns list: Items of the reverse connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ItemGraph.setReverse(self,reverse)

type: instancemethod

doc: Sets the direction that is used for lookup when using the angular brackets [] :param bool reverse: If True the graph is looked up forwards, if False, backwards.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.ItemGraph.type

type: property

doc: :getter: Returns the name of the graph type that this instance represents. :return type: basestring

modo.meshgeometry.util.item.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.util.item.Joint

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint._item

type: property

modo.meshgeometry.util.item.Joint._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.Joint.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.Joint.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.Joint.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.Joint.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.Joint.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.Joint.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.Joint.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.Joint.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.Joint.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.Joint.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.Joint.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.Joint.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.Joint.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.Joint.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Joint.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Joint.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Joint.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Joint.scene

type: property

modo.meshgeometry.util.item.Joint.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.Joint.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Joint.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Joint.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.Joint.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Keyframes

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Keyframes._indexFromTime(self,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Keyframes.add(self,val,time)

type: instancemethod

doc: Adds a new keyframe at the specified time. If no time value is passed as an argument a keyframe is set at the current time. :param time: optional time (in seconds) to add a keyframe at. :type time: float :param val: the value to set for the keyframe :type val: int or float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Keyframes.delete(self)

type: instancemethod

doc: Deletes the current key

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Keyframes.first(self)

type: instancemethod

doc: Go to the first keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Keyframes.getSlopeType(self,side)

type: instancemethod

doc: Returns the slope type for either side of a keyframe. :returns: a tuple of the slope type set for the side of the keyframe specified and whether the slope is weighted or not. :rtype: (int, int)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Keyframes.last(self)

type: instancemethod

doc: Go to the last keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Keyframes.next(self)

type: instancemethod

doc: Go to the next keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Keyframes.numKeys

type: property

doc: :getter: Returns the number of keyframes found :rtype: int

modo.meshgeometry.util.item.Keyframes.prev(self)

type: instancemethod

doc: Go to the previous keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Keyframes.setIndex(self,index)

type: instancemethod

doc: Go to the keyframe by index

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Keyframes.setSlopeType(self,stype,side)

type: instancemethod

doc: Sets the slope type for either side of a keyframe - **SLOPE_DIRECT** the slope of the tangent is set based on the value stored in the key. - **SLOPE_AUTO** the slope of the tangent is calculated automatically with regard to surrounding keys. This is similar to the slope adjustments made by TCB curves. - **SLOPE_LINEAR_IN** the slope of the tangent is calculated to align with the previous key's value. - **SLOPE_LINEAR_OUT** the slope of the tangent is calculated to align with the next key's value. - **SLOPE_FLAT** The slope of the tangent is set to zero. - **SLOPE_AUTOFLAT** the same as auto but if a neighboring key has the same value as the key the slope is set to zero. - **SLOPE_STEPPED** Maintains the value of the previous key between pairs of keys. :param stype: set the slope type for the current keyframe. Can be one of: | lx.symbol.iSLOPE_AUTO | lx.symbol.iSLOPE_AUTOFLAT | lx.symbol.iSLOPE_DIRECT | lx.symbol.iSLOPE_FLAT | lx.symbol.iSLOPE_LINEAR_IN | lx.symbol.iSLOPE_LINEAR_OUT | lx.symbol.iSLOPE_STEPPED :type stype: int :param side: the side of the key (in or out) the slope type is being set for :type side: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.Keyframes.time

type: property

doc: Returns & sets the time for the current keyframe. :setter: Sets the time :param time: the time to move the key to. :type time: float :getter: Returns the time of the current keyframe :rtype: float

modo.meshgeometry.util.item.Keyframes.value

type: property

doc: Convenience property to get & set value of the current keyframe for the 90% case of an unbroken key. :setter: Sets a value :param val: the value to set for the key. :type val: int or float :getter: Returns the value of an (unbroken) key. :rtype: int or float

modo.meshgeometry.util.item.Light

type: type

doc: Base Light item class. Each light item encapsulates both an lx.object.Item object (via inheritance from the Item class) of a specific modo light type and a corresponding lx.object.Item of type 'lightMaterial' as a :class:`LightMaterial` object via the light's material property. example:: # to set the diffuse color on the currently selected spotlight spotlight = modo.SpotLight() spotlight.material.ch_diffCol.set((0.7, 0.1, 0.5)) .. note:: Although "Light" isn't technically a base class since, like all other classes in modo.item, it inherits from "Item", it does encapsulate modo's 'Light" supertype and can be treated as a kind of 'pseudo' base class for all modo's light types. As such it should not be instantiated directly, create one of the specific light types instead. | :param light: Optional light item object to wrap. Must be a specific type of light, not the light supertype. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid light item selected. :raises TypeError: if the item passed as an argument isn't an instance of a specific subclass of Light.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light._item

type: property

modo.meshgeometry.util.item.Light._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.Light.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.Light.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.Light.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.Light.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.Light.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.Light.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.Light.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.Light.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.Light.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.Light.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.meshgeometry.util.item.Light.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.Light.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.Light.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.Light.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.Light.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Light.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Light.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Light.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Light.scene

type: property

modo.meshgeometry.util.item.Light.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.Light.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Light.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Light.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.Light.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.LightMaterial

type: type

doc: Wraps a light material texture layer item. :param material: the light material item to be wrapped. :type material: lx.object.Item of type lx.symbol.sITYPE_LIGHTMATERIAL

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial._item

type: property

modo.meshgeometry.util.item.LightMaterial._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.LightMaterial.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.LightMaterial.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.LightMaterial.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.LightMaterial.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.LightMaterial.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.LightMaterial.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.LightMaterial.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.LightMaterial.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.LightMaterial.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.LightMaterial.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.light

type: property

doc: :getter: The light item that the material belongs to. :param light_item: the light item to parent the material layer to. :type light_item: an instance of one of the modo.Light types or either lx.object.Item or lxu.object.Item of a specific light item type :returns: the parent light item. :rtype: one of the modo light types.

modo.meshgeometry.util.item.LightMaterial.lightCol

type: property

doc: A wrapper property for the light material item's three diffuse color channels. Returns an :class:`modo.channel.Channel` object :getter: Returns a channelTriple object. :rtype: modo.channel.channelTriple

modo.meshgeometry.util.item.LightMaterial.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.LightMaterial.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.LightMaterial.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.LightMaterial.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.LightMaterial.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.scatteringCol

type: property

doc: :getter: A wrapper property for the light material item's three scattering color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.meshgeometry.util.item.LightMaterial.scene

type: property

modo.meshgeometry.util.item.LightMaterial.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.LightMaterial.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LightMaterial.shadCol

type: property

doc: :getter: A wrapper property for the light material item's three shadow color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.meshgeometry.util.item.LightMaterial.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.LightMaterial.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Locator

type: type

doc: Locator item class. Takes an optional 'locator' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'locator' or an item name or ID to look up. If no locator item is supplied as an argument an attempt will be made to wrap the most recently selected locator item. :param locator: Optional locator item object (type lx.symbol.sITYPE_LOCATOR) or string (item name or ID) to look up. :type locator: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the locator argument but no item with that name/ID can be found. Hint: Items of other locator derived types should be casted as LocatorSuperType, casting to this class will fail.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator._item

type: property

modo.meshgeometry.util.item.Locator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.Locator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.Locator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.Locator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.Locator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.Locator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.Locator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.Locator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.Locator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.Locator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.Locator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.Locator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.Locator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.Locator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.Locator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Locator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Locator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Locator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Locator.scene

type: property

modo.meshgeometry.util.item.Locator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.Locator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Locator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Locator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.Locator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.LocatorSuperType

type: type

doc: The LocatorSuperType reflects all items that can be seen and transformed in the 3d view. Locators have transform items that hold the respective transform channels, such as position and rotation.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType._item

type: property

modo.meshgeometry.util.item.LocatorSuperType._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.LocatorSuperType.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.LocatorSuperType.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.LocatorSuperType.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.LocatorSuperType.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.LocatorSuperType.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.LocatorSuperType.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.LocatorSuperType.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.LocatorSuperType.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.LocatorSuperType.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.LocatorSuperType.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.LocatorSuperType.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.LocatorSuperType.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.LocatorSuperType.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.LocatorSuperType.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.LocatorSuperType.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.LocatorSuperType.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.LocatorSuperType.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.LocatorSuperType.scene

type: property

modo.meshgeometry.util.item.LocatorSuperType.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.LocatorSuperType.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.LocatorSuperType.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.LocatorSuperType.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.LocatorSuperType.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Matrix4

type: type

doc: Matrix class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4._getIdentity

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4._matrix_calcRotation

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4._matrix_vectorMultiply

type: function

doc: :param matrix: :param vector: :param result: :return:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4._MatrixToEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4._rotOrderToList

type: function

doc: takes a string in form of 'xyz' and returns a list in form of [0,1,2]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4.asEuler(self,degrees,order)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4.asRotateMatrix(self)

type: instancemethod

doc: Removes the translation part of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4.copy(self)

type: instancemethod

doc: :return: A copy of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4.determinant(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4.fromEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4.invert(self)

type: instancemethod

doc: Inverts this Matrix in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4.inverted(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4.position

type: property

doc: :getter: Returns the translation part of this matrix :rtype: tuple :setter: Sets the translation part of this matrix :param position: Position :type position: iterable

modo.meshgeometry.util.item.Matrix4.scale(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4.set(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4.setIdentity(self)

type: instancemethod

doc: Set this matrix to it's identity

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4.transpose(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Matrix4.transposed(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal. It returns a new transposed matrix.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Mesh

type: type

doc: Mesh item class. Takes an optional 'mesh' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'mesh' or an item name or ID to look up. If no mesh item is supplied as an argument an attempt will be made to wrap the most recently selected mesh layer. :param mesh: Optional mesh item object (type lx.symbol.sITYPE_MESH) or string (item name or ID) to look up. :type mesh: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid mesh item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'mesh' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the mesh argument but no item with that name/ID can be found. The mesh geometry can be accessed by the :class:`geometry` attribute. .. py:attribute:: geometry :rtype: :class:`MeshGeometry`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh._item

type: property

modo.meshgeometry.util.item.Mesh._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.Mesh.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.Mesh.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.Mesh.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.Mesh.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.geometry

type: property

modo.meshgeometry.util.item.Mesh.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.Mesh.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.Mesh.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.Mesh.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.Mesh.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.Mesh.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.Mesh.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.Mesh.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.Mesh.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.Mesh.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.Mesh.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Mesh.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Mesh.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Mesh.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Mesh.scene

type: property

modo.meshgeometry.util.item.Mesh.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.Mesh.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Mesh.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Mesh.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.Mesh.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.MeshGeometry

type: type

doc: A class wrapped around lx.object.Mesh that provides access to geometry of a given Mesh Item :param item: Input item :type item: type lx.object.Item :param mode: Mode in which to access the mesh. Possible values: "write", "read", "deformed" :type mode: string. Note: References are always read only. :return: Instance of MeshGeometry :raises LookupError: If item was passed as string and could not be found in the scene :raises TypeError: If the passed item is not of type lx.object.Item :raises TypeError: If the passed item is not compatible with the mesh type example:: scene = modo.scene.current() # Get the selected mesh for mesh in scene.selectedByType("mesh")[:1]: # Print the number of vertices print len(mesh.geometry.vertices) # Print point position by index print mesh.geometry.vertices[4] # Set point position by index mesh.geometry.vertices[4] = (1,2,3) # Iterate all vertices and move them by 0.1 in x for point in mesh.geometry.vertices: point += (0.1, 0, 0) # Update to see mesh changes mesh.geometry.setMeshEdits() .. py:attribute:: vertices :rtype: :class:`MeshVertices` .. py:attribute:: edges :rtype: :class:`MeshEdges` .. py:attribute:: polygons :rtype: :class:`MeshPolygons` .. py:attribute:: vmaps :rtype: :class:`MeshMaps`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.util.item.MeshGeometry._item

type: property

modo.meshgeometry.util.item.MeshGeometry._SEL_SVC

type: Selection

modo.meshgeometry.util.item.MeshGeometry._UNDO_SVC

type: Undo

modo.meshgeometry.util.item.MeshGeometry.accessMode

type: property

modo.meshgeometry.util.item.MeshGeometry.boundingBox

type: property

doc: Get the bounding box of this mesh :getter: Returns a tuple representing the two corners of the bounding box

modo.meshgeometry.util.item.MeshGeometry.getMeshCenter(self)

type: instancemethod

doc: :return: Center position of the bounding box

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.util.item.MeshGeometry.internalMesh

type: property

doc: :getter: Returns the wrapped lx.object.Mesh object

modo.meshgeometry.util.item.MeshGeometry.numEdges

type: property

doc: :getter: returns the vertex count of this mesh

modo.meshgeometry.util.item.MeshGeometry.numPolygons

type: property

doc: :getter: returns the polygon count of this mesh

modo.meshgeometry.util.item.MeshGeometry.numVertices

type: property

doc: :getter: returns the vertex count of this mesh

modo.meshgeometry.util.item.MeshGeometry.setAccessMode(self,value,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.util.item.MeshGeometry.setMeshEdits(self,editType)

type: instancemethod

doc: Updates mesh edits applying previous changes. :param lx.symbol.f_MESHEDIT_* editType: The type of change to set. Defaults to all.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.util.item.PhotometricLight

type: type

doc: Photometric (ies) light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Photometric Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Photometric Light item. :param light: Optional Photometric light item object (type lx.symbol.sITYPE_PHOTOMETRYLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Photometric light item selected. :raises TypeError: if the item passed as an argument isn't either a Photometric light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight._item

type: property

modo.meshgeometry.util.item.PhotometricLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.PhotometricLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.PhotometricLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.PhotometricLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.PhotometricLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.PhotometricLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.PhotometricLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.PhotometricLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.PhotometricLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.PhotometricLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.PhotometricLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.meshgeometry.util.item.PhotometricLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.PhotometricLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.PhotometricLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.PhotometricLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.PhotometricLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.PhotometricLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.PhotometricLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.PhotometricLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.PhotometricLight.scene

type: property

modo.meshgeometry.util.item.PhotometricLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.PhotometricLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PhotometricLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.PhotometricLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.PhotometricLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.PointLight

type: type

doc: Point light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Point Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Point Light item. :param light: Optional Point light item object (type lx.symbol.sITYPE_POINTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Point light item selected. :raises TypeError: if the item passed as an argument isn't either a Point light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight._item

type: property

modo.meshgeometry.util.item.PointLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.PointLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.PointLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.PointLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.PointLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.PointLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.PointLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.PointLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.PointLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.PointLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.PointLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.meshgeometry.util.item.PointLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.PointLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.PointLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.PointLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.PointLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.PointLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.PointLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.PointLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.PointLight.scene

type: property

modo.meshgeometry.util.item.PointLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.PointLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.PointLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.PointLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.PointLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Portal

type: type

doc: Portal item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Portal' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Portal item. :param light: Optional Portal item object (type 'portal') or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Portal item selected. :raises TypeError: if the item passed as an argument isn't either a Portal item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal._item

type: property

modo.meshgeometry.util.item.Portal._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.Portal.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.Portal.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.Portal.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.Portal.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.Portal.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.Portal.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.Portal.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.Portal.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.Portal.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.Portal.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.meshgeometry.util.item.Portal.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.Portal.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.Portal.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.Portal.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.Portal.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Portal.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Portal.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Portal.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.Portal.scene

type: property

modo.meshgeometry.util.item.Portal.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.Portal.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.Portal.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.Portal.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.Portal.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.RenderPassGroup

type: type

doc: Render pass group :param groupItem: either a group item or an item name/ID to look up. :type groupItem: lx.object.item or modo.item.Item :raises TypeError: if the item is not a 'Group" item. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup._item

type: property

modo.meshgeometry.util.item.RenderPassGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.addPass(self,name)

type: instancemethod

doc: Add a render pass item to the group. :param name: optional name for the render pass :type name: basestring :return: the render pass item. :rtype: modo.item.ActionClip

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.RenderPassGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.RenderPassGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.RenderPassGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.RenderPassGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.meshgeometry.util.item.RenderPassGroup.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.meshgeometry.util.item.RenderPassGroup.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.RenderPassGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.RenderPassGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.RenderPassGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.RenderPassGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.meshgeometry.util.item.RenderPassGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.RenderPassGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.RenderPassGroup.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.meshgeometry.util.item.RenderPassGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.RenderPassGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.RenderPassGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.RenderPassGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.RenderPassGroup.passes

type: property

doc: :getter: Returns a lst of render passes in the group. :returns: list of render pass items :rtype: list of modo.item.ActionClip

modo.meshgeometry.util.item.RenderPassGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.scene

type: property

modo.meshgeometry.util.item.RenderPassGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.RenderPassGroup.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.RenderPassGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.RenderPassGroup.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.meshgeometry.util.item.scene

type: module

doc: .. module:: modo.scene :synopsis: Scene class and scene level utility functions. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.meshgeometry.util.item.scene.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.meshgeometry.util.item.scene.ChannelRead contents:
  • modo.meshgeometry.util.item.scene.ChannelRead.__class__
  • modo.meshgeometry.util.item.scene.ChannelRead.__delattr__
  • modo.meshgeometry.util.item.scene.ChannelRead.__dict__
  • modo.meshgeometry.util.item.scene.ChannelRead.__doc__
  • modo.meshgeometry.util.item.scene.ChannelRead.__format__
  • modo.meshgeometry.util.item.scene.ChannelRead.__getattr__
  • modo.meshgeometry.util.item.scene.ChannelRead.__getattribute__
  • modo.meshgeometry.util.item.scene.ChannelRead.__hash__
  • modo.meshgeometry.util.item.scene.ChannelRead.__init__
  • modo.meshgeometry.util.item.scene.ChannelRead.__module__
  • modo.meshgeometry.util.item.scene.ChannelRead.__new__
  • modo.meshgeometry.util.item.scene.ChannelRead.__reduce__
  • modo.meshgeometry.util.item.scene.ChannelRead.__reduce_ex__
  • modo.meshgeometry.util.item.scene.ChannelRead.__repr__
  • modo.meshgeometry.util.item.scene.ChannelRead.__setattr__
  • modo.meshgeometry.util.item.scene.ChannelRead.__sizeof__
  • modo.meshgeometry.util.item.scene.ChannelRead.__str__
  • modo.meshgeometry.util.item.scene.ChannelRead.__subclasshook__
  • modo.meshgeometry.util.item.scene.ChannelRead.__weakref__
  • modo.meshgeometry.util.item.scene.ChannelRead.set

modo.meshgeometry.util.item.scene.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.scene.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.meshgeometry.util.item.scene.ChannelWrite contents:
  • modo.meshgeometry.util.item.scene.ChannelWrite.__class__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__delattr__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__dict__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__doc__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__format__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__getattr__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__getattribute__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__hash__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__init__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__module__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__new__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__reduce__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__reduce_ex__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__repr__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__setattr__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__sizeof__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__str__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__subclasshook__
  • modo.meshgeometry.util.item.scene.ChannelWrite.__weakref__
  • modo.meshgeometry.util.item.scene.ChannelWrite.set

modo.meshgeometry.util.item.scene.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.meshgeometry.util.item.scene.current

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.meshgeometry.util.item.scene.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.scene.Scene

type: type

doc: The main scene class. Takes an optional lx.object.Scene object as an argument. If none is provided (the default) then the currently selected scene is used which will mostly be the general case. The module function :func:`sceneList` makes use of the scene parameter to return a list of open scenes as modo.scene.Scene objects. :param scene: Optional scene object to wrap. :type scene: lx.object.Scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene._allItems(self)

type: instancemethod

doc: Utility function to get all items of a scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene._Scene__ItemAdd(self,groupType)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene._Scene__setupTextureLayerType(self,newItem)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.actors

type: property

doc: Returns a list of all actors in the scene :getter: Returns a list of Actor objects found in this scene :rtype: list

modo.meshgeometry.util.item.scene.Scene.addActor(self,name,items,makeActive)

type: instancemethod

doc: Add a new actor to the scene :returns modo.item.Actor: Actor item object :param basestring name: optional name :param list items: list of items for the actor to contain

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.addCamera(self,name)

type: instancemethod

doc: Add a new camera item to the scene :returns: camera item :rtype: modo.item.Camera :param name: optional name for the camera. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.addGroup(self,name,gtype)

type: instancemethod

doc: Add a new group item to the scene :returns: group item :rtype: modo.item.Group :param name: optional name for the group item. :type name: basestring :param gtype: optional group type, can be one of the default group types ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader') or any other string to create a custom group type. Default is an empty string which creates a 'Genera' group type. :type gtype: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.addItem(self,itype,name)

type: instancemethod

doc: Add a new item to the scene :returns: item :rtype: modo.item.item :param itype: item type :type itype: modo.Constant :param name: optional name for the item. :type name: basestring :raises TypeError: When failing

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.addJointLocator(self,name,parent)

type: instancemethod

doc: Adds a new joint to the scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.addMaterial(self,matType,name,index)

type: instancemethod

doc: Adds a new material to the scene :param modo.c.MATERIAL_* matType: Type of material to create :param name: Optional name for the material :returns Item: The material item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.addMesh(self,name)

type: instancemethod

doc: Add a new mesh item to the scene :returns: mesh item :rtype: modo.item.Mesh :param name: optional name for the mesh. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.addRenderPassGroup(self,name)

type: instancemethod

doc: Add a render pass group to the scene :returns: render pass group. :rtype: modo.item.RenderPassGroup :param name: optional name for the render pass group. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.camera(self,cam)

type: instancemethod

doc: Returns a camera item in the scene. The supplied argument can be either a string (camera ID or name) or an integer (camera index in the scene's collection of cameras) :param cam: the camera :type cam: basestring or int :returns: camera item :rtype: modo.item.Camera

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.cameraCount

type: property

doc: Number of cameras in the scene. :getter: Returns the number of camera items. :rtype: int

modo.meshgeometry.util.item.scene.Scene.cameras

type: property

doc: Returns a list of all the camera items in the scene as modo.item.Camera objects. :getter: Returns a list of the camera items in the scene. :rtype: list of modo.item.Camera

modo.meshgeometry.util.item.scene.Scene.currentRange

type: property

doc: Set or read the current frame range start and end frame value should be passed in as a tuple. :setter: Sets the range :param frange: frame range - a tuple of ints (start, end). :type frange: tuple :Getter: Returns the start and end frames. :rtype: tuple :exception ValueError: if supplied start frame is higher than end frame.

modo.meshgeometry.util.item.scene.Scene.deformers(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.deselect(self,itemObj)

type: instancemethod

doc: Deselect an item. :param itemObj: the item to deselect. Clears the entire selection if None :type itemObj: basestring (item name or ID) or instance of either lx.object.Item or modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.duplicateItem(self,item,instance)

type: instancemethod

doc: Creates and returns a duplicate of the passed item :returns item: Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.filename

type: property

doc: File path of the scene. :getter: Returns the file path of the scene or 'None' if not yet saved. :rtype: basestring or None

modo.meshgeometry.util.item.scene.Scene.fps

type: property

doc: Scene frames per second. .. note:: There is no way to set the fps value from the Python API for any scene other than the currently selected one. Therefore, for any other scene the property will be read only and attempts to write to it will throw an AttributeError. | :getter: Returns the Frames Per Second :rtype: float :setter: Sets the Frames Per Second :param fps: Scene frames per second. :type fps: float :raises: AttributeError

modo.meshgeometry.util.item.scene.Scene.getGroups(self,gtype)

type: instancemethod

doc: Returns all groups of the given kind :param gtype: optional group type, can be one of the default group types ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader') or any other string to create a custom group type. Default is an empty string which creates a 'Genera' group type. You can also pass a list of multiple group types. :returns list: List of groups matching the type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.groups

type: property

doc: Returns a list of all the group items in the scene as modo.item.Group objects. :getter: Returns a list of the group items in the scene. :rtype: list of modo.item.Group

modo.meshgeometry.util.item.scene.Scene.item(self,name)

type: instancemethod

doc: Look up item by name :param string item: Name to look for :returns item: Found item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.itemCount(self,itype)

type: instancemethod

doc: The number of items of a specified type in the scene. :param itype: type of the items. :type itype: int or basestring :returns: the number of items of the specified type in the scene. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.items(self,itype,name,superType)

type: instancemethod

doc: List of items of the specified type in the scene. :param itype: the item type. :type itype: :param basestring name: Optionally filter result by this text. Can use * and ? wildcards for globbing. :param bool superType: If True, all items that have 'itype' as superType are listed. Else, only items of specifically that type are returned. :returns: list of the items of the specified type in the scene. If itype is None, all items in the scene are returned. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.iterItems(self,itype,name,superType)

type: instancemethod

doc: Same as items(), but returns a generator object.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.lightCount

type: property

doc: Number of lights in the scene. :getter: Returns the number of light items. :rtype: int

modo.meshgeometry.util.item.scene.Scene.locators

type: property

modo.meshgeometry.util.item.scene.Scene.meshCount

type: property

doc: Number of mesh items in the scene. :getter: Returns the number of mesh items. :rtype: int

modo.meshgeometry.util.item.scene.Scene.meshes

type: property

doc: Returns a list of all the mesh items in the scene as modo.item.Mesh objects. :getter: Returns a list of the mesh items in the scene. :rtype: list of modo.item.Mesh

modo.meshgeometry.util.item.scene.Scene.name

type: property

doc: Friendly name of the scene. :getter: Returns the name of the scene. :rtype: basestring

modo.meshgeometry.util.item.scene.Scene.removeItems(self,itm,children)

type: instancemethod

doc: :param Item: Item to remove from the scene :param bool children: If True, all found children are deleted also

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.renderCamera

type: property

doc: Get & set the scene's current render camera :setter: Set the scene's current render camera :param camera: the camera item to set as the current render camera. :type camera: lx.object.Item of type 'Camera' :getter: Returns the current render camera. :rtype: modo.Item.Camera

modo.meshgeometry.util.item.scene.Scene.renderItem

type: property

doc: :getter: Returns the first found render item of the scene :rtype: Item

modo.meshgeometry.util.item.scene.Scene.renderPassGroups

type: property

doc: Returns a list of all the render pass group items in the scene as modo.item.RenderPassGroup objects. :getter: Returns a list of the render pass group items in the scene. :rtype: list of modo.item.Group

modo.meshgeometry.util.item.scene.Scene.sceneItem

type: property

doc: The scene's 'scene item' :getter: Returns the scene's scene item. :rtype: lxdt.item.Item (type lx.symbol.sITYPE_SCENE)

modo.meshgeometry.util.item.scene.Scene.sceneRange

type: property

doc: Set or read the scene's frame range start and end frame value should be passed in as a tuple. :setter: Sets the range :param frange: frame range - a tuple of ints (start, end). :type frange: tuple :getter: Returns the start and end frames. :rtype: tuple :exception ValueError: if supplied start frame is higher than end frame.

modo.meshgeometry.util.item.scene.Scene.select(self,itemObj,add)

type: instancemethod

doc: :param itemObj: the item to select. :type item: basestring (item name or ID) or instance of either lx.object.Item or modo.item.Item :param add: whether to add to the current selection, False replaces the current selection. :type add: bool Note:: To clear the selection of the scene, please use deselect() instead.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.Scene.selected

type: property

doc: Selected items in the scene. :getter: Returns the selected items :rtype: list

modo.meshgeometry.util.item.scene.Scene.selectedByType(self,itype,superType)

type: instancemethod

doc: Returns the selected items of a specific type as modo.item.Item objects. :param itype: item type to filter on. :type itype: int or string :return: selcted items of specified type. :param bool superType: If True, all items derived fom itype are listed. Otherwise only items of the exact type of itype. :rtype: list of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.sceneList

type: function

doc: Get a list of all the currently open scenes. :returns: Collection of currently open scenes as modo.scene.Scene objects. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.meshgeometry.util.item.scene.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.meshgeometry.util.item.SpotLight

type: type

doc: Spotlight item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Spotlight' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Spotlight item. :param light: Optional Spotlight item object (type lx.symbol.sITYPE_SPOTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Spotlight item selected. :raises TypeError: if the item passed as an argument isn't either a Spotlight item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight._item

type: property

modo.meshgeometry.util.item.SpotLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.SpotLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.SpotLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.SpotLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.SpotLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.SpotLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.SpotLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.SpotLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.SpotLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.SpotLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.SpotLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.meshgeometry.util.item.SpotLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.SpotLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.SpotLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.SpotLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.SpotLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.SpotLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.SpotLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.SpotLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.SpotLight.scene

type: property

modo.meshgeometry.util.item.SpotLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.SpotLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.SpotLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.SpotLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.SpotLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.TextureLocator

type: type

doc: Texture locator item class. Takes an optional 'texloc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Texture locator' or an item name or ID to look up. If no texloc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param texloc: Optional texture locator item object (type lx.symbol.sITYPE_TEXTURELOC) or string (item name or ID) to look up. :type texloc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid texture locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'texture locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the texloc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator._item

type: property

modo.meshgeometry.util.item.TextureLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.TextureLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.TextureLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.TextureLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.TextureLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.TextureLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.TextureLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.TextureLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.TextureLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.TextureLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.TextureLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.TextureLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.TextureLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.TextureLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.TextureLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.TextureLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.TextureLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.TextureLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.TextureLocator.scene

type: property

modo.meshgeometry.util.item.TextureLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.TextureLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TextureLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.TextureLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.TextureLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.TransformItem

type: type

doc: Contains a group of animatable transform channels of a locator object. It has convenience functions for access of the locator's position, rotation and scale. examples:: # We retrieve two meshes from the current scene by name, assuming they exist cube = modo.Mesh('Cube') sphere = modo.Mesh('Sphere') # Set rotation values cube.rotation.set(10, 20, 30, degrees=True) # Link the position.x channel of the sphere to to the position.x channel of the cube cube.position.y.setLink(0, sphere.position.x, 0) # Set position values to zero cube.position.clear() # Insert keyframe for rotation on frame 21 frame = lx.service.Value().FrameToTime(21) cube.rotation.insertKey(time=frame)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem._item

type: property

modo.meshgeometry.util.item.TransformItem._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem._TransformItem__rotationType

type: long

modo.meshgeometry.util.item.TransformItem._TransformItem__scaleType

type: long

modo.meshgeometry.util.item.TransformItem._TransformItem__toDegrees

type: function

doc: Utility function to consume and process the 'degrees' argument for the set function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem._TransformItem__transformType(self)

type: instancemethod

doc: Utility function that returns the corresponding string value from __types, for later channel lookup

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem._TransformItem__translationType

type: long
modo.meshgeometry.util.item.TransformItem._TransformItem__types type: dict

modo.meshgeometry.util.item.TransformItem._TransformItem__types.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.meshgeometry.util.item.TransformItem._TransformItem__types.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.meshgeometry.util.item.TransformItem._TransformItem__types.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.meshgeometry.util.item.TransformItem._TransformItem__types.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.meshgeometry.util.item.TransformItem._TransformItem__types.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.meshgeometry.util.item.TransformItem._TransformItem__types.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.meshgeometry.util.item.TransformItem._TransformItem__types.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.meshgeometry.util.item.TransformItem._TransformItem__types.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.meshgeometry.util.item.TransformItem._TransformItem__types.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.meshgeometry.util.item.TransformItem._TransformItem__types.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.meshgeometry.util.item.TransformItem._TransformItem__types.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.meshgeometry.util.item.TransformItem._TransformItem__types.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.meshgeometry.util.item.TransformItem._TransformItem__types.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.meshgeometry.util.item.TransformItem._TransformItem__types.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.meshgeometry.util.item.TransformItem._TransformItem__types.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.meshgeometry.util.item.TransformItem._TransformItem__types.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.meshgeometry.util.item.TransformItem._TransformItem__types.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.meshgeometry.util.item.TransformItem._TransformItem__types.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.meshgeometry.util.item.TransformItem.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.TransformItem.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.TransformItem.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.clear(self)

type: instancemethod

doc: Sets values to 1.0 if is a scaling transform and to 0.0 otherwise :param arguments: Same as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.TransformItem.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.TransformItem.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.get(self,time,action,degrees)

type: instancemethod

doc: Function to get the x, y and z-values of the locator at once. :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when getting rotation. :param keywords: Same as as :meth:`Channel.get` :returns tuple: x, y and z values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.TransformItem.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.TransformItem.insertKey(self,time,action)

type: instancemethod

doc: Inserts a keyframe on the respective x, y and z channels. :param float time: Time in seconds to create the new keys :param action: Action to create keys in.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.TransformItem.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.TransformItem.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.TransformItem.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.TransformItem.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.TransformItem.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.TransformItem.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.TransformItem.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.TransformItem.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.removeKey(self,time,action)

type: instancemethod

doc:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.scene

type: property

modo.meshgeometry.util.item.TransformItem.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.TransformItem.set(self,values,time,key,action,degrees)

type: instancemethod

doc: Function to set the x, y and z-values of the locator at once. :param values: either three floats, or a list/tuple containing the x, y, z values to set :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when setting rotation. :param keywords: Same as as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItem.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.TransformItem.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.TransformItem.x

type: property

doc: Shortcut to the x channel of the locator :getter: :class:`Channel` :rtype: float

modo.meshgeometry.util.item.TransformItem.y

type: property

doc: Shortcut to the y channel of the locator :getter: :class:`Channel` :rtype: float

modo.meshgeometry.util.item.TransformItem.z

type: property

doc: Shortcut to the z channel of the locator :getter: :class:`Channel` :rtype: float

modo.meshgeometry.util.item.TransformItems

type: type

doc: Container class for the stacked transform items of a Locator object. Transform items contain channels for either position, rotation or scale. The order of how they are processed can be changed and new transform items can be inserted or existing ones deleted. example:: scene = modo.scene.current() # Grab first selected object for item in scene.selected[:1]: # Print the amount of transform items print len(item.transforms) # Add a new position transform item position = item.transforms.insert('position', values=(1,0,0), name='New_Position') # Add a new scale transform item scale = item.transforms.insert('scale', values=(2,2,2), name='Scaled') # Swap the indices of the first two transform items item.transforms.reposition(0,1) # Delete item.transforms.delete(scale) # Clear values of all transforms for i in item.transforms: i.clear()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems._item

type: property

modo.meshgeometry.util.item.TransformItems._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.meshgeometry.util.item.TransformItems.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.meshgeometry.util.item.TransformItems.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.meshgeometry.util.item.TransformItems.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.meshgeometry.util.item.TransformItems.delete(self,index)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.meshgeometry.util.item.TransformItems.idNames(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.meshgeometry.util.item.TransformItems.insert(self,xfrmType,placement,values,name)

type: instancemethod

doc: Insert a new transform item into the transform chain. The 'prepend' and 'append' placement values place the new item at the top or bottom of the stack, where 'pre' and 'post' place it around the respective transform highlighted in black in the channel view. I am myself confused about the order though, is it bottom to top or the other way around? Note that modo always keeps at least one of each type of transform, so when you attempt to delete it a new one is created automatically. :param string xfrmType: 'position', 'rotation' or 'scale' :param string placement: 'prepend', 'append', 'pre' or 'post' :param tuple values: Initial xyz values to be optionally set :param string name: Optional name

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.meshgeometry.util.item.TransformItems.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.meshgeometry.util.item.TransformItems.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.meshgeometry.util.item.TransformItems.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.meshgeometry.util.item.TransformItems.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.meshgeometry.util.item.TransformItems.names(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.meshgeometry.util.item.TransformItems.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.meshgeometry.util.item.TransformItems.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.meshgeometry.util.item.TransformItems.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.TransformItems.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.TransformItems.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.reposition(self,indexFrom,indexTo)

type: instancemethod

doc: Places a transform item to the provided index of the transform item stack :param int indexFrom: Source Index of the item that is to be moved :param int indexTo: Destination index to place item at

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.TransformItems.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.meshgeometry.util.item.TransformItems.scene

type: property

modo.meshgeometry.util.item.TransformItems.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.meshgeometry.util.item.TransformItems.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.meshgeometry.util.item.TransformItems.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.TransformItems.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.meshgeometry.util.item.TransformItems.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.meshgeometry.util.item.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.meshgeometry.util.item.Vector3

type: type

doc: Vector3 class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.angle(self,other)

type: instancemethod

doc: Returns the angle between this and another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.copy(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.cross(self,other)

type: instancemethod

doc: Returns a new vector with the result of crossing this vector with another

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.distanceBetweenPoints(self,other)

type: instancemethod

doc: Returns the distance between this and another point

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.dot(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.equals(self,other,tolerance)

type: instancemethod

doc: Returns if this vector is equivalent to another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.length(self)

type: instancemethod

doc: Returns the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.mulByMatrixAsPoint(self,other)

type: instancemethod

doc: Transform this point's position by a Matrix4 in place. :param Matrix4 other: Other Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.normal(self)

type: instancemethod

doc: Returns a normalized copy of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.normalize(self)

type: instancemethod

doc: Normalizes this vector in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.rotate(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.rotateByAxisAngle(self,axis,angle)

type: instancemethod

doc: Rotates this vector by a given axis and angle :param Vector3 axis: This axis to rotate about :param float angle: The angle in radians to rotate by

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.rotateByQuat(self,other)

type: instancemethod

doc: Rotate this vector by a quaternion

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.setLength(self,value)

type: instancemethod

doc: Sets the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.util.item.Vector3.x

type: property

doc: Quick access to the x component of the vector

modo.meshgeometry.util.item.Vector3.y

type: property

doc: Quick access to the y component of the vector

modo.meshgeometry.util.item.Vector3.z

type: property

doc: Quick access to the z component of the vector

modo.meshgeometry.util.makeQuickCommand

type: function

doc: Quick way to create a command. Note that a command can only be blessed (registered) once per modo session, so this command will fail when attempting to rebless a command. :param string name: Name that the command will be callable by. Example: cmds.myCommand :param function func: The function that the command should call :param iterable arguments: A sequence of name:defaultvalue pairs to make arguments that will be passed on to the function :param basestring userName: The user name :param basestring description: Summary of the command's purpose :param basestring toolTip: Text that appears when hovering over the button example:: import modo def func_args(mystring, myint): print mystring, myint def func_simple(): print 'simple function, no arguments' modo.util.makeQuickCommand('test.simple', func_simple) modo.util.makeQuickCommand('test.args', func_args, (('mystring', 'mesh021'), ('myint', 23))) lx.eval('test.simple') lx.eval('test.args mesh022 24')

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.meshgeometry.util.paths

type: function

doc: Access to various system paths. :param basestring key: Specific path to return. Returns all if None. :returns dictionary or string: Dictionary containing all paths or single path as string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.meshgeometry.util.testGlobalInterpreter

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.meshgeometry.util.typeToFunc

type: function

doc: selects an item class constructor based on the item type passed as an argument and returns that as a class instantiation 'function' object to call the correct class in methods that eg select by item type or return items. In essence it acts as a sort of clearing house to try to ensure that any recognised but unwrapped items are wrapped with the correct modo.item.xxx type before being returned. example usage:: # get a list of all the light items in a scene where each light in the list is returned as the correctly # wrapped modo version of each light sub-type. import modo scene = modo.Scene() lights = [] for light in scene.ItemList(modo.c.LIGHT_TYPE): func = modo.c.typeToFunc(light.Type()) lights.append(func(light)) # or more succinctly as a list comprehension: lights = [modo.c.typeToFunc(light.Type())(light) for light in scene.ItemList(modo.c.LIGHT_TYPE)]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.meshgeometry.UVMap

type: type

doc: Access for UV-Map values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.UVMap._accessor

type: property

modo.meshgeometry.UVMap._setValue(self,vertexIndex,values,nonContinuous)

type: instancemethod

doc: Sets UV values for this vertex. :param int vertexIndex: Index of vertex to change the UV values for :param tuple values: The u and v values to set (pair consisting of of 2 floats) :param bool nonContinuous: If True, the values are applied to all non-continuous occurrences on polygons found for this vertex. If False, Nothing happens when the vertex has non-continuous UVs.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.UVMap._UVMap__get(self,point_index,listContinuous,listNonContinuous)

type: instancemethod

doc: Get the u and v value from a point A vertexuv pair is continuous if it's uv values are shared by multiple polygons. :param int point_index: Index of the vertex to get the uv value from :param bool listContinuous: Skips vertices with continuous uvs if False. :param bool listNonContinuous: Skips vertices with non-continuous uvs if False. :returns: A tuple containing the u and v values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.UVMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.meshgeometry.UVMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.UVMap.continuousVertices(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.UVMap.disContinuousVertices(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.UVMap.fromMesh(cls)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.UVMap.id

type: property

modo.meshgeometry.UVMap.iterContinuousVertices(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.UVMap.iterDisContinuousVertices(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.UVMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.meshgeometry.vec3

type: module

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.pyc

modo.meshgeometry.vec3.add

type: function

doc: result = a + b

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.meshgeometry.vec3.cross

type: function

doc: result = a x b

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.meshgeometry.vec3.dot

type: function

doc: result = a . b

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.meshgeometry.vec3.length

type: function

doc: result = sqrt (v . v)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.meshgeometry.vec3.math

type: module

doc: This module is always available. It provides access to the mathematical functions defined by the C standard.

modo.meshgeometry.vec3.math.acos()

type: builtin_function_or_method

doc: acos(x) Return the arc cosine (measured in radians) of x.

modo.meshgeometry.vec3.math.acosh()

type: builtin_function_or_method

doc: acosh(x) Return the hyperbolic arc cosine (measured in radians) of x.

modo.meshgeometry.vec3.math.asin()

type: builtin_function_or_method

doc: asin(x) Return the arc sine (measured in radians) of x.

modo.meshgeometry.vec3.math.asinh()

type: builtin_function_or_method

doc: asinh(x) Return the hyperbolic arc sine (measured in radians) of x.

modo.meshgeometry.vec3.math.atan()

type: builtin_function_or_method

doc: atan(x) Return the arc tangent (measured in radians) of x.

modo.meshgeometry.vec3.math.atan2()

type: builtin_function_or_method

doc: atan2(y, x) Return the arc tangent (measured in radians) of y/x. Unlike atan(y/x), the signs of both x and y are considered.

modo.meshgeometry.vec3.math.atanh()

type: builtin_function_or_method

doc: atanh(x) Return the hyperbolic arc tangent (measured in radians) of x.

modo.meshgeometry.vec3.math.ceil()

type: builtin_function_or_method

doc: ceil(x) Return the ceiling of x as a float. This is the smallest integral value >= x.

modo.meshgeometry.vec3.math.copysign()

type: builtin_function_or_method

doc: copysign(x, y) Return x with the sign of y.

modo.meshgeometry.vec3.math.cos()

type: builtin_function_or_method

doc: cos(x) Return the cosine of x (measured in radians).

modo.meshgeometry.vec3.math.cosh()

type: builtin_function_or_method

doc: cosh(x) Return the hyperbolic cosine of x.

modo.meshgeometry.vec3.math.degrees()

type: builtin_function_or_method

doc: degrees(x) Convert angle x from radians to degrees.

modo.meshgeometry.vec3.math.e

type: float

modo.meshgeometry.vec3.math.erf()

type: builtin_function_or_method

doc: erf(x) Error function at x.

modo.meshgeometry.vec3.math.erfc()

type: builtin_function_or_method

doc: erfc(x) Complementary error function at x.

modo.meshgeometry.vec3.math.exp()

type: builtin_function_or_method

doc: exp(x) Return e raised to the power of x.

modo.meshgeometry.vec3.math.expm1()

type: builtin_function_or_method

doc: expm1(x) Return exp(x)-1. This function avoids the loss of precision involved in the direct evaluation of exp(x)-1 for small x.

modo.meshgeometry.vec3.math.fabs()

type: builtin_function_or_method

doc: fabs(x) Return the absolute value of the float x.

modo.meshgeometry.vec3.math.factorial()

type: builtin_function_or_method

doc: factorial(x) -> Integral Find x!. Raise a ValueError if x is negative or non-integral.

modo.meshgeometry.vec3.math.floor()

type: builtin_function_or_method

doc: floor(x) Return the floor of x as a float. This is the largest integral value <= x.

modo.meshgeometry.vec3.math.fmod()

type: builtin_function_or_method

doc: fmod(x, y) Return fmod(x, y), according to platform C. x % y may differ.

modo.meshgeometry.vec3.math.frexp()

type: builtin_function_or_method

doc: frexp(x) Return the mantissa and exponent of x, as pair (m, e). m is a float and e is an int, such that x = m * 2.**e. If x is 0, m and e are both 0. Else 0.5 <= abs(m) < 1.0.

modo.meshgeometry.vec3.math.fsum()

type: builtin_function_or_method

doc: fsum(iterable) Return an accurate floating point sum of values in the iterable. Assumes IEEE-754 floating point arithmetic.

modo.meshgeometry.vec3.math.gamma()

type: builtin_function_or_method

doc: gamma(x) Gamma function at x.

modo.meshgeometry.vec3.math.hypot()

type: builtin_function_or_method

doc: hypot(x, y) Return the Euclidean distance, sqrt(x*x + y*y).

modo.meshgeometry.vec3.math.isinf()

type: builtin_function_or_method

doc: isinf(x) -> bool Check if float x is infinite (positive or negative).

modo.meshgeometry.vec3.math.isnan()

type: builtin_function_or_method

doc: isnan(x) -> bool Check if float x is not a number (NaN).

modo.meshgeometry.vec3.math.ldexp()

type: builtin_function_or_method

doc: ldexp(x, i) Return x * (2**i).

modo.meshgeometry.vec3.math.lgamma()

type: builtin_function_or_method

doc: lgamma(x) Natural logarithm of absolute value of Gamma function at x.

modo.meshgeometry.vec3.math.log()

type: builtin_function_or_method

doc: log(x[, base]) Return the logarithm of x to the given base. If the base not specified, returns the natural logarithm (base e) of x.

modo.meshgeometry.vec3.math.log10()

type: builtin_function_or_method

doc: log10(x) Return the base 10 logarithm of x.

modo.meshgeometry.vec3.math.log1p()

type: builtin_function_or_method

doc: log1p(x) Return the natural logarithm of 1+x (base e). The result is computed in a way which is accurate for x near zero.

modo.meshgeometry.vec3.math.modf()

type: builtin_function_or_method

doc: modf(x) Return the fractional and integer parts of x. Both results carry the sign of x and are floats.

modo.meshgeometry.vec3.math.pi

type: float

modo.meshgeometry.vec3.math.pow()

type: builtin_function_or_method

doc: pow(x, y) Return x**y (x to the power of y).

modo.meshgeometry.vec3.math.radians()

type: builtin_function_or_method

doc: radians(x) Convert angle x from degrees to radians.

modo.meshgeometry.vec3.math.sin()

type: builtin_function_or_method

doc: sin(x) Return the sine of x (measured in radians).

modo.meshgeometry.vec3.math.sinh()

type: builtin_function_or_method

doc: sinh(x) Return the hyperbolic sine of x.

modo.meshgeometry.vec3.math.sqrt()

type: builtin_function_or_method

doc: sqrt(x) Return the square root of x.

modo.meshgeometry.vec3.math.tan()

type: builtin_function_or_method

doc: tan(x) Return the tangent of x (measured in radians).

modo.meshgeometry.vec3.math.tanh()

type: builtin_function_or_method

doc: tanh(x) Return the hyperbolic tangent of x.

modo.meshgeometry.vec3.math.trunc()

type: builtin_function_or_method

doc: trunc(x:Real) -> Integral Truncates x to the nearest Integral toward 0. Uses the __trunc__ magic method.

modo.meshgeometry.vec3.normalize

type: function

doc: result = a / length(a)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.meshgeometry.vec3.scale

type: function

doc: result = v * s

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.meshgeometry.vec3.sub

type: function

doc: result = a - b

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.meshgeometry.vec3.vector

type: function

doc: Return a 3-vector (tuple of three values): Vector(x,y,z) = (x,y,z) Vector(a) = (a,a,a) Vector() = (0,0,0)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\lxu\vector.py

modo.meshgeometry.Vector3

type: type

doc: Vector3 class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.angle(self,other)

type: instancemethod

doc: Returns the angle between this and another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.copy(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.cross(self,other)

type: instancemethod

doc: Returns a new vector with the result of crossing this vector with another

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.distanceBetweenPoints(self,other)

type: instancemethod

doc: Returns the distance between this and another point

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.dot(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.equals(self,other,tolerance)

type: instancemethod

doc: Returns if this vector is equivalent to another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.length(self)

type: instancemethod

doc: Returns the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.mulByMatrixAsPoint(self,other)

type: instancemethod

doc: Transform this point's position by a Matrix4 in place. :param Matrix4 other: Other Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.normal(self)

type: instancemethod

doc: Returns a normalized copy of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.normalize(self)

type: instancemethod

doc: Normalizes this vector in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.rotate(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.rotateByAxisAngle(self,axis,angle)

type: instancemethod

doc: Rotates this vector by a given axis and angle :param Vector3 axis: This axis to rotate about :param float angle: The angle in radians to rotate by

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.rotateByQuat(self,other)

type: instancemethod

doc: Rotate this vector by a quaternion

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.setLength(self,value)

type: instancemethod

doc: Sets the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.meshgeometry.Vector3.x

type: property

doc: Quick access to the x component of the vector

modo.meshgeometry.Vector3.y

type: property

doc: Quick access to the y component of the vector

modo.meshgeometry.Vector3.z

type: property

doc: Quick access to the z component of the vector

modo.meshgeometry.VertexMap

type: type

doc: A class representing a vertex map, accessible by point indices through angular brackets. Base class for other maps.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

    modo.meshgeometry.VertexMap contents:
  • modo.meshgeometry.VertexMap.__class__
  • modo.meshgeometry.VertexMap.__delattr__
  • modo.meshgeometry.VertexMap.__dict__
  • modo.meshgeometry.VertexMap.__doc__
  • modo.meshgeometry.VertexMap.__format__
  • modo.meshgeometry.VertexMap.__getattr__
  • modo.meshgeometry.VertexMap.__getattribute__
  • modo.meshgeometry.VertexMap.__getitem__
  • modo.meshgeometry.VertexMap.__hash__
  • modo.meshgeometry.VertexMap.__init__
  • modo.meshgeometry.VertexMap.__iter__
  • modo.meshgeometry.VertexMap.__len__
  • modo.meshgeometry.VertexMap.__module__
  • modo.meshgeometry.VertexMap.__new__
  • modo.meshgeometry.VertexMap.__nonzero__
  • modo.meshgeometry.VertexMap.__reduce__
  • modo.meshgeometry.VertexMap.__reduce_ex__
  • modo.meshgeometry.VertexMap.__repr__
  • modo.meshgeometry.VertexMap.__setattr__
  • modo.meshgeometry.VertexMap.__setitem__
  • modo.meshgeometry.VertexMap.__sizeof__
  • modo.meshgeometry.VertexMap.__str__
  • modo.meshgeometry.VertexMap.__subclasshook__
  • modo.meshgeometry.VertexMap.__weakref__
  • modo.meshgeometry.VertexMap._accessor
  • modo.meshgeometry.VertexMap.accessor
  • modo.meshgeometry.VertexMap.clear
  • modo.meshgeometry.VertexMap.fromMesh
  • modo.meshgeometry.VertexMap.id
  • modo.meshgeometry.VertexMap.name

modo.meshgeometry.VertexMap._accessor

type: property

modo.meshgeometry.VertexMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.meshgeometry.VertexMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.VertexMap.fromMesh(cls,geometry,accessor,ID,map_type,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.VertexMap.id

type: property

modo.meshgeometry.VertexMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.meshgeometry.VertexNormalMap

type: type

doc: Vertex Normal Map class * Available from Modo 901 SP1 and upwards * Allows manipulation of a vertex normal map on either vertex or polygon basis. Example:: import modo reload(modo) # Create a subdivided cube lx.eval('script.implicit {Unit Cube Item}') lx.eval('poly.subdivide ccsds') mesh = modo.Mesh('Cube') # Create a vertex normal map normals = mesh.geometry.vmaps.addVertexNormalMap() normalValue = (0, 0, -1) # Set the normal value on every vertex per polygon for polygon in mesh.geometry.polygons: for vert in polygon.vertices: normals.setNormal( normalValue, vert, polygon) # Update the mesh mesh.geometry.setMeshEdits(lx.symbol.f_MESHEDIT_MAP_OTHER) # Select the vertex normal map to see the effect lx.eval('select.vertexMap "%s" norm replace' % normals.name)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.VertexNormalMap._accessor

type: property

modo.meshgeometry.VertexNormalMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.meshgeometry.VertexNormalMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.VertexNormalMap.fromMesh(cls)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.VertexNormalMap.getNormal(self,vertex,polygon)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.VertexNormalMap.id

type: property

modo.meshgeometry.VertexNormalMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.meshgeometry.VertexNormalMap.setNormal(self,values,vertex,polygon,normalize)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.weakref

type: module

doc: Weak reference support for Python. This module is an implementation of PEP 205: http://www.python.org/dev/peps/pep-0205/

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\weakref.pyc

modo.meshgeometry.weakref.CallableProxyType

type: type

    modo.meshgeometry.weakref.CallableProxyType contents:
  • modo.meshgeometry.weakref.CallableProxyType.__abs__
  • modo.meshgeometry.weakref.CallableProxyType.__add__
  • modo.meshgeometry.weakref.CallableProxyType.__and__
  • modo.meshgeometry.weakref.CallableProxyType.__call__
  • modo.meshgeometry.weakref.CallableProxyType.__class__
  • modo.meshgeometry.weakref.CallableProxyType.__cmp__
  • modo.meshgeometry.weakref.CallableProxyType.__contains__
  • modo.meshgeometry.weakref.CallableProxyType.__delattr__
  • modo.meshgeometry.weakref.CallableProxyType.__delitem__
  • modo.meshgeometry.weakref.CallableProxyType.__delslice__
  • modo.meshgeometry.weakref.CallableProxyType.__div__
  • modo.meshgeometry.weakref.CallableProxyType.__divmod__
  • modo.meshgeometry.weakref.CallableProxyType.__doc__
  • modo.meshgeometry.weakref.CallableProxyType.__float__
  • modo.meshgeometry.weakref.CallableProxyType.__floordiv__
  • modo.meshgeometry.weakref.CallableProxyType.__format__
  • modo.meshgeometry.weakref.CallableProxyType.__getattribute__
  • modo.meshgeometry.weakref.CallableProxyType.__getitem__
  • modo.meshgeometry.weakref.CallableProxyType.__getslice__
  • modo.meshgeometry.weakref.CallableProxyType.__hash__
  • modo.meshgeometry.weakref.CallableProxyType.__iadd__
  • modo.meshgeometry.weakref.CallableProxyType.__iand__
  • modo.meshgeometry.weakref.CallableProxyType.__idiv__
  • modo.meshgeometry.weakref.CallableProxyType.__ifloordiv__
  • modo.meshgeometry.weakref.CallableProxyType.__ilshift__
  • modo.meshgeometry.weakref.CallableProxyType.__imod__
  • modo.meshgeometry.weakref.CallableProxyType.__imul__
  • modo.meshgeometry.weakref.CallableProxyType.__index__
  • modo.meshgeometry.weakref.CallableProxyType.__init__
  • modo.meshgeometry.weakref.CallableProxyType.__int__
  • modo.meshgeometry.weakref.CallableProxyType.__invert__
  • modo.meshgeometry.weakref.CallableProxyType.__ior__
  • modo.meshgeometry.weakref.CallableProxyType.__ipow__
  • modo.meshgeometry.weakref.CallableProxyType.__irshift__
  • modo.meshgeometry.weakref.CallableProxyType.__isub__
  • modo.meshgeometry.weakref.CallableProxyType.__iter__
  • modo.meshgeometry.weakref.CallableProxyType.__itruediv__
  • modo.meshgeometry.weakref.CallableProxyType.__ixor__
  • modo.meshgeometry.weakref.CallableProxyType.__len__
  • modo.meshgeometry.weakref.CallableProxyType.__long__
  • modo.meshgeometry.weakref.CallableProxyType.__lshift__
  • modo.meshgeometry.weakref.CallableProxyType.__mod__
  • modo.meshgeometry.weakref.CallableProxyType.__mul__
  • modo.meshgeometry.weakref.CallableProxyType.__neg__
  • modo.meshgeometry.weakref.CallableProxyType.__new__
  • modo.meshgeometry.weakref.CallableProxyType.__nonzero__
  • modo.meshgeometry.weakref.CallableProxyType.__or__
  • modo.meshgeometry.weakref.CallableProxyType.__pos__
  • modo.meshgeometry.weakref.CallableProxyType.__pow__
  • modo.meshgeometry.weakref.CallableProxyType.__radd__
  • modo.meshgeometry.weakref.CallableProxyType.__rand__
  • modo.meshgeometry.weakref.CallableProxyType.__rdiv__
  • modo.meshgeometry.weakref.CallableProxyType.__rdivmod__
  • modo.meshgeometry.weakref.CallableProxyType.__reduce__
  • modo.meshgeometry.weakref.CallableProxyType.__reduce_ex__
  • modo.meshgeometry.weakref.CallableProxyType.__repr__
  • modo.meshgeometry.weakref.CallableProxyType.__rfloordiv__
  • modo.meshgeometry.weakref.CallableProxyType.__rlshift__
  • modo.meshgeometry.weakref.CallableProxyType.__rmod__
  • modo.meshgeometry.weakref.CallableProxyType.__rmul__
  • modo.meshgeometry.weakref.CallableProxyType.__ror__
  • modo.meshgeometry.weakref.CallableProxyType.__rpow__
  • modo.meshgeometry.weakref.CallableProxyType.__rrshift__
  • modo.meshgeometry.weakref.CallableProxyType.__rshift__
  • modo.meshgeometry.weakref.CallableProxyType.__rsub__
  • modo.meshgeometry.weakref.CallableProxyType.__rtruediv__
  • modo.meshgeometry.weakref.CallableProxyType.__rxor__
  • modo.meshgeometry.weakref.CallableProxyType.__setattr__
  • modo.meshgeometry.weakref.CallableProxyType.__setitem__
  • modo.meshgeometry.weakref.CallableProxyType.__setslice__
  • modo.meshgeometry.weakref.CallableProxyType.__sizeof__
  • modo.meshgeometry.weakref.CallableProxyType.__str__
  • modo.meshgeometry.weakref.CallableProxyType.__sub__
  • modo.meshgeometry.weakref.CallableProxyType.__subclasshook__
  • modo.meshgeometry.weakref.CallableProxyType.__truediv__
  • modo.meshgeometry.weakref.CallableProxyType.__xor__
  • modo.meshgeometry.weakref.CallableProxyType.next

modo.meshgeometry.weakref.CallableProxyType.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.weakref.getweakrefcount()

type: builtin_function_or_method

doc: getweakrefcount(object) -- return the number of weak references to 'object'.

modo.meshgeometry.weakref.getweakrefs()

type: builtin_function_or_method

doc: getweakrefs(object) -- return a list of all weak reference objects that point to 'object'.

modo.meshgeometry.weakref.KeyedRef

type: type

doc: Specialized reference that includes a key corresponding to the value. This is used in the WeakValueDictionary to avoid having to create a function object for each key stored in the mapping. A shared callback object can use the 'key' attribute of a KeyedRef instead of getting a reference to the key from an enclosing scope.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\weakref.pyc

    modo.meshgeometry.weakref.KeyedRef contents:
  • modo.meshgeometry.weakref.KeyedRef.__call__
  • modo.meshgeometry.weakref.KeyedRef.__class__
  • modo.meshgeometry.weakref.KeyedRef.__delattr__
  • modo.meshgeometry.weakref.KeyedRef.__doc__
  • modo.meshgeometry.weakref.KeyedRef.__eq__
  • modo.meshgeometry.weakref.KeyedRef.__format__
  • modo.meshgeometry.weakref.KeyedRef.__ge__
  • modo.meshgeometry.weakref.KeyedRef.__getattribute__
  • modo.meshgeometry.weakref.KeyedRef.__gt__
  • modo.meshgeometry.weakref.KeyedRef.__hash__
  • modo.meshgeometry.weakref.KeyedRef.__init__
  • modo.meshgeometry.weakref.KeyedRef.__le__
  • modo.meshgeometry.weakref.KeyedRef.__lt__
  • modo.meshgeometry.weakref.KeyedRef.__module__
  • modo.meshgeometry.weakref.KeyedRef.__ne__
  • modo.meshgeometry.weakref.KeyedRef.__new__
  • modo.meshgeometry.weakref.KeyedRef.__reduce__
  • modo.meshgeometry.weakref.KeyedRef.__reduce_ex__
  • modo.meshgeometry.weakref.KeyedRef.__repr__
  • modo.meshgeometry.weakref.KeyedRef.__setattr__
  • modo.meshgeometry.weakref.KeyedRef.__sizeof__
  • modo.meshgeometry.weakref.KeyedRef.__slots__
  • modo.meshgeometry.weakref.KeyedRef.__str__
  • modo.meshgeometry.weakref.KeyedRef.__subclasshook__
  • modo.meshgeometry.weakref.KeyedRef.key

modo.meshgeometry.weakref.KeyedRef.key

type: member_descriptor

modo.meshgeometry.weakref.proxy()

type: builtin_function_or_method

doc: proxy(object[, callback]) -- create a proxy object that weakly references 'object'. 'callback', if given, is called with a reference to the proxy when 'object' is about to be finalized.

modo.meshgeometry.weakref.ProxyType

type: type

    modo.meshgeometry.weakref.ProxyType contents:
  • modo.meshgeometry.weakref.ProxyType.__abs__
  • modo.meshgeometry.weakref.ProxyType.__add__
  • modo.meshgeometry.weakref.ProxyType.__and__
  • modo.meshgeometry.weakref.ProxyType.__class__
  • modo.meshgeometry.weakref.ProxyType.__cmp__
  • modo.meshgeometry.weakref.ProxyType.__contains__
  • modo.meshgeometry.weakref.ProxyType.__delattr__
  • modo.meshgeometry.weakref.ProxyType.__delitem__
  • modo.meshgeometry.weakref.ProxyType.__delslice__
  • modo.meshgeometry.weakref.ProxyType.__div__
  • modo.meshgeometry.weakref.ProxyType.__divmod__
  • modo.meshgeometry.weakref.ProxyType.__doc__
  • modo.meshgeometry.weakref.ProxyType.__float__
  • modo.meshgeometry.weakref.ProxyType.__floordiv__
  • modo.meshgeometry.weakref.ProxyType.__format__
  • modo.meshgeometry.weakref.ProxyType.__getattribute__
  • modo.meshgeometry.weakref.ProxyType.__getitem__
  • modo.meshgeometry.weakref.ProxyType.__getslice__
  • modo.meshgeometry.weakref.ProxyType.__hash__
  • modo.meshgeometry.weakref.ProxyType.__iadd__
  • modo.meshgeometry.weakref.ProxyType.__iand__
  • modo.meshgeometry.weakref.ProxyType.__idiv__
  • modo.meshgeometry.weakref.ProxyType.__ifloordiv__
  • modo.meshgeometry.weakref.ProxyType.__ilshift__
  • modo.meshgeometry.weakref.ProxyType.__imod__
  • modo.meshgeometry.weakref.ProxyType.__imul__
  • modo.meshgeometry.weakref.ProxyType.__index__
  • modo.meshgeometry.weakref.ProxyType.__init__
  • modo.meshgeometry.weakref.ProxyType.__int__
  • modo.meshgeometry.weakref.ProxyType.__invert__
  • modo.meshgeometry.weakref.ProxyType.__ior__
  • modo.meshgeometry.weakref.ProxyType.__ipow__
  • modo.meshgeometry.weakref.ProxyType.__irshift__
  • modo.meshgeometry.weakref.ProxyType.__isub__
  • modo.meshgeometry.weakref.ProxyType.__iter__
  • modo.meshgeometry.weakref.ProxyType.__itruediv__
  • modo.meshgeometry.weakref.ProxyType.__ixor__
  • modo.meshgeometry.weakref.ProxyType.__len__
  • modo.meshgeometry.weakref.ProxyType.__long__
  • modo.meshgeometry.weakref.ProxyType.__lshift__
  • modo.meshgeometry.weakref.ProxyType.__mod__
  • modo.meshgeometry.weakref.ProxyType.__mul__
  • modo.meshgeometry.weakref.ProxyType.__neg__
  • modo.meshgeometry.weakref.ProxyType.__new__
  • modo.meshgeometry.weakref.ProxyType.__nonzero__
  • modo.meshgeometry.weakref.ProxyType.__or__
  • modo.meshgeometry.weakref.ProxyType.__pos__
  • modo.meshgeometry.weakref.ProxyType.__pow__
  • modo.meshgeometry.weakref.ProxyType.__radd__
  • modo.meshgeometry.weakref.ProxyType.__rand__
  • modo.meshgeometry.weakref.ProxyType.__rdiv__
  • modo.meshgeometry.weakref.ProxyType.__rdivmod__
  • modo.meshgeometry.weakref.ProxyType.__reduce__
  • modo.meshgeometry.weakref.ProxyType.__reduce_ex__
  • modo.meshgeometry.weakref.ProxyType.__repr__
  • modo.meshgeometry.weakref.ProxyType.__rfloordiv__
  • modo.meshgeometry.weakref.ProxyType.__rlshift__
  • modo.meshgeometry.weakref.ProxyType.__rmod__
  • modo.meshgeometry.weakref.ProxyType.__rmul__
  • modo.meshgeometry.weakref.ProxyType.__ror__
  • modo.meshgeometry.weakref.ProxyType.__rpow__
  • modo.meshgeometry.weakref.ProxyType.__rrshift__
  • modo.meshgeometry.weakref.ProxyType.__rshift__
  • modo.meshgeometry.weakref.ProxyType.__rsub__
  • modo.meshgeometry.weakref.ProxyType.__rtruediv__
  • modo.meshgeometry.weakref.ProxyType.__rxor__
  • modo.meshgeometry.weakref.ProxyType.__setattr__
  • modo.meshgeometry.weakref.ProxyType.__setitem__
  • modo.meshgeometry.weakref.ProxyType.__setslice__
  • modo.meshgeometry.weakref.ProxyType.__sizeof__
  • modo.meshgeometry.weakref.ProxyType.__str__
  • modo.meshgeometry.weakref.ProxyType.__sub__
  • modo.meshgeometry.weakref.ProxyType.__subclasshook__
  • modo.meshgeometry.weakref.ProxyType.__truediv__
  • modo.meshgeometry.weakref.ProxyType.__unicode__
  • modo.meshgeometry.weakref.ProxyType.__xor__
  • modo.meshgeometry.weakref.ProxyType.next

modo.meshgeometry.weakref.ProxyType.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.meshgeometry.weakref.ProxyTypes

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.weakref.ref

type: type

    modo.meshgeometry.weakref.ref contents:
  • modo.meshgeometry.weakref.ref.__call__
  • modo.meshgeometry.weakref.ref.__class__
  • modo.meshgeometry.weakref.ref.__delattr__
  • modo.meshgeometry.weakref.ref.__doc__
  • modo.meshgeometry.weakref.ref.__eq__
  • modo.meshgeometry.weakref.ref.__format__
  • modo.meshgeometry.weakref.ref.__ge__
  • modo.meshgeometry.weakref.ref.__getattribute__
  • modo.meshgeometry.weakref.ref.__gt__
  • modo.meshgeometry.weakref.ref.__hash__
  • modo.meshgeometry.weakref.ref.__init__
  • modo.meshgeometry.weakref.ref.__le__
  • modo.meshgeometry.weakref.ref.__lt__
  • modo.meshgeometry.weakref.ref.__ne__
  • modo.meshgeometry.weakref.ref.__new__
  • modo.meshgeometry.weakref.ref.__reduce__
  • modo.meshgeometry.weakref.ref.__reduce_ex__
  • modo.meshgeometry.weakref.ref.__repr__
  • modo.meshgeometry.weakref.ref.__setattr__
  • modo.meshgeometry.weakref.ref.__sizeof__
  • modo.meshgeometry.weakref.ref.__str__
  • modo.meshgeometry.weakref.ref.__subclasshook__
modo.meshgeometry.weakref.ReferenceError

type: type

doc: Weak ref proxy used after referent went away.

    modo.meshgeometry.weakref.ReferenceError contents:
  • modo.meshgeometry.weakref.ReferenceError.__class__
  • modo.meshgeometry.weakref.ReferenceError.__delattr__
  • modo.meshgeometry.weakref.ReferenceError.__dict__
  • modo.meshgeometry.weakref.ReferenceError.__doc__
  • modo.meshgeometry.weakref.ReferenceError.__format__
  • modo.meshgeometry.weakref.ReferenceError.__getattribute__
  • modo.meshgeometry.weakref.ReferenceError.__getitem__
  • modo.meshgeometry.weakref.ReferenceError.__getslice__
  • modo.meshgeometry.weakref.ReferenceError.__hash__
  • modo.meshgeometry.weakref.ReferenceError.__init__
  • modo.meshgeometry.weakref.ReferenceError.__new__
  • modo.meshgeometry.weakref.ReferenceError.__reduce__
  • modo.meshgeometry.weakref.ReferenceError.__reduce_ex__
  • modo.meshgeometry.weakref.ReferenceError.__repr__
  • modo.meshgeometry.weakref.ReferenceError.__setattr__
  • modo.meshgeometry.weakref.ReferenceError.__setstate__
  • modo.meshgeometry.weakref.ReferenceError.__sizeof__
  • modo.meshgeometry.weakref.ReferenceError.__str__
  • modo.meshgeometry.weakref.ReferenceError.__subclasshook__
  • modo.meshgeometry.weakref.ReferenceError.__unicode__
  • modo.meshgeometry.weakref.ReferenceError.args
  • modo.meshgeometry.weakref.ReferenceError.message

modo.meshgeometry.weakref.ReferenceError.args

type: getset_descriptor

modo.meshgeometry.weakref.ReferenceError.message

type: getset_descriptor

modo.meshgeometry.weakref.ReferenceType

type: type

    modo.meshgeometry.weakref.ReferenceType contents:
  • modo.meshgeometry.weakref.ReferenceType.__call__
  • modo.meshgeometry.weakref.ReferenceType.__class__
  • modo.meshgeometry.weakref.ReferenceType.__delattr__
  • modo.meshgeometry.weakref.ReferenceType.__doc__
  • modo.meshgeometry.weakref.ReferenceType.__eq__
  • modo.meshgeometry.weakref.ReferenceType.__format__
  • modo.meshgeometry.weakref.ReferenceType.__ge__
  • modo.meshgeometry.weakref.ReferenceType.__getattribute__
  • modo.meshgeometry.weakref.ReferenceType.__gt__
  • modo.meshgeometry.weakref.ReferenceType.__hash__
  • modo.meshgeometry.weakref.ReferenceType.__init__
  • modo.meshgeometry.weakref.ReferenceType.__le__
  • modo.meshgeometry.weakref.ReferenceType.__lt__
  • modo.meshgeometry.weakref.ReferenceType.__ne__
  • modo.meshgeometry.weakref.ReferenceType.__new__
  • modo.meshgeometry.weakref.ReferenceType.__reduce__
  • modo.meshgeometry.weakref.ReferenceType.__reduce_ex__
  • modo.meshgeometry.weakref.ReferenceType.__repr__
  • modo.meshgeometry.weakref.ReferenceType.__setattr__
  • modo.meshgeometry.weakref.ReferenceType.__sizeof__
  • modo.meshgeometry.weakref.ReferenceType.__str__
  • modo.meshgeometry.weakref.ReferenceType.__subclasshook__
modo.meshgeometry.weakref.UserDict

type: module

doc: A more or less complete user-defined wrapper around dictionary objects.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\UserDict.pyc

modo.meshgeometry.weakref.UserDict._abcoll

type: module

doc: Abstract Base Classes (ABCs) for collections, according to PEP 3119. DON'T USE THIS MODULE DIRECTLY! The classes here should be imported via collections; they are defined here only to alleviate certain bootstrapping issues. Unit tests are in test_collections.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll._hasattr

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta

type: type

doc: Metaclass for defining Abstract Base Classes (ABCs). Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as 'virtual subclasses' -- these and their descendants will be considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won't show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via super()).

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\abc.pyc

    modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta contents:
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__base__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__bases__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__basicsize__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__call__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__class__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__delattr__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__dict__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__dictoffset__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__doc__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__eq__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__flags__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__format__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__ge__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__getattribute__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__gt__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__hash__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__init__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__instancecheck__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__itemsize__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__le__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__lt__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__module__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__mro__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__name__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__ne__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__new__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__reduce__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__reduce_ex__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__repr__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__setattr__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__sizeof__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__str__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__subclasscheck__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__subclasses__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__subclasshook__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.__weakrefoffset__
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta._abc_invalidation_counter
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta._dump_registry
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.mro
  • modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.register

modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta._abc_invalidation_counter

type: int

modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta._dump_registry(cls,file)

type: instancemethod

doc: Debug helper to print the ABC registry.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.mro()

type: method_descriptor

doc: mro() -> list return a type's method resolution order

modo.meshgeometry.weakref.UserDict._abcoll.ABCMeta.register(cls,subclass)

type: instancemethod

doc: Register a virtual subclass of an ABC.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.meshgeometry.weakref.UserDict._abcoll.abstractmethod

type: function

doc: A decorator indicating abstract methods. Requires that the metaclass is ABCMeta or derived from it. A class that has a metaclass derived from ABCMeta cannot be instantiated unless all of its abstract methods are overridden. The abstract methods can be called using any of the normal 'super' call mechanisms. Usage: class C: __metaclass__ = ABCMeta @abstractmethod def my_abstract_method(self, ...): ...

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.meshgeometry.weakref.UserDict._abcoll.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict._abcoll.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.meshgeometry.weakref.UserDict._abcoll.sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.meshgeometry.weakref.UserDict._abcoll.sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.meshgeometry.weakref.UserDict._abcoll.sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.meshgeometry.weakref.UserDict._abcoll.sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.weakref.UserDict._abcoll.sys.api_version

type: int

modo.meshgeometry.weakref.UserDict._abcoll.sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.weakref.UserDict._abcoll.sys.byteorder

type: str

modo.meshgeometry.weakref.UserDict._abcoll.sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.meshgeometry.weakref.UserDict._abcoll.sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.meshgeometry.weakref.UserDict._abcoll.sys.copyright

type: str

modo.meshgeometry.weakref.UserDict._abcoll.sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.meshgeometry.weakref.UserDict._abcoll.sys.dllhandle

type: long

modo.meshgeometry.weakref.UserDict._abcoll.sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.meshgeometry.weakref.UserDict._abcoll.sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.meshgeometry.weakref.UserDict._abcoll.sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.meshgeometry.weakref.UserDict._abcoll.sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.meshgeometry.weakref.UserDict._abcoll.sys.exc_type

type: type

doc: Inappropriate argument type.

modo.meshgeometry.weakref.UserDict._abcoll.sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.meshgeometry.weakref.UserDict._abcoll.sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.meshgeometry.weakref.UserDict._abcoll.sys.exec_prefix

type: str

modo.meshgeometry.weakref.UserDict._abcoll.sys.executable

type: str

modo.meshgeometry.weakref.UserDict._abcoll.sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.meshgeometry.weakref.UserDict._abcoll.sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.meshgeometry.weakref.UserDict._abcoll.sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.meshgeometry.weakref.UserDict._abcoll.sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.meshgeometry.weakref.UserDict._abcoll.sys.float_repr_style

type: str

modo.meshgeometry.weakref.UserDict._abcoll.sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.meshgeometry.weakref.UserDict._abcoll.sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.meshgeometry.weakref.UserDict._abcoll.sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.meshgeometry.weakref.UserDict._abcoll.sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.meshgeometry.weakref.UserDict._abcoll.sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.meshgeometry.weakref.UserDict._abcoll.sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.meshgeometry.weakref.UserDict._abcoll.sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.meshgeometry.weakref.UserDict._abcoll.sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.meshgeometry.weakref.UserDict._abcoll.sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.meshgeometry.weakref.UserDict._abcoll.sys.hexversion

type: int

modo.meshgeometry.weakref.UserDict._abcoll.sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.meshgeometry.weakref.UserDict._abcoll.sys.maxint

type: int

modo.meshgeometry.weakref.UserDict._abcoll.sys.maxsize

type: long

modo.meshgeometry.weakref.UserDict._abcoll.sys.maxunicode

type: int

modo.meshgeometry.weakref.UserDict._abcoll.sys.meta_path

type: list

modo.meshgeometry.weakref.UserDict._abcoll.sys.modules

type: dict

modo.meshgeometry.weakref.UserDict._abcoll.sys.path

type: list

modo.meshgeometry.weakref.UserDict._abcoll.sys.path_hooks

type: list

modo.meshgeometry.weakref.UserDict._abcoll.sys.path_importer_cache

type: dict

modo.meshgeometry.weakref.UserDict._abcoll.sys.platform

type: str

modo.meshgeometry.weakref.UserDict._abcoll.sys.prefix

type: str

modo.meshgeometry.weakref.UserDict._abcoll.sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.meshgeometry.weakref.UserDict._abcoll.sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.meshgeometry.weakref.UserDict._abcoll.sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.meshgeometry.weakref.UserDict._abcoll.sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.meshgeometry.weakref.UserDict._abcoll.sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.meshgeometry.weakref.UserDict._abcoll.sys.stderr

type: SESysStdErr

modo.meshgeometry.weakref.UserDict._abcoll.sys.stdin

type: SESysStdIn

modo.meshgeometry.weakref.UserDict._abcoll.sys.stdout

type: SESysStdOut

modo.meshgeometry.weakref.UserDict._abcoll.sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.meshgeometry.weakref.UserDict._abcoll.sys.version

type: str

modo.meshgeometry.weakref.UserDict._abcoll.sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.meshgeometry.weakref.UserDict._abcoll.sys.warnoptions

type: list

modo.meshgeometry.weakref.UserDict._abcoll.sys.winver

type: str

modo.meshgeometry.weakref.UserDict._abcoll.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.meshgeometry.weakref.UserDict.DictMixin()

type: classobj

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\UserDict.pyc

modo.meshgeometry.weakref.UserDict.DictMixin().clear(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.DictMixin().get(self,key,default)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.DictMixin().has_key(self,key)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.DictMixin().items(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.DictMixin().iteritems(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.DictMixin().iterkeys(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.DictMixin().itervalues(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.DictMixin().pop(self,key)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.DictMixin().popitem(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.DictMixin().setdefault(self,key,default)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.DictMixin().update(self,other)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.DictMixin().values(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict()

type: classobj

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\UserDict.pyc

modo.meshgeometry.weakref.UserDict.IterableUserDict().clear(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().copy(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().fromkeys(cls,iterable,value)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().get(self,key,failobj)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().has_key(self,key)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().items(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().iteritems(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().iterkeys(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().itervalues(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().keys(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().pop(self,key)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().popitem(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().setdefault(self,key,failobj)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().update(self,dict)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.IterableUserDict().values(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.UserDict.UserDict()

type: classobj

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\UserDict.pyc

modo.meshgeometry.weakref.WeakKeyDictionary()

type: classobj

doc: Mapping class that references keys weakly. Entries in the dictionary will be discarded when there is no longer a strong reference to the key. This can be used to associate additional data with an object owned by other parts of an application without adding attributes to those objects. This can be especially useful with objects that override attribute accesses.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\weakref.pyc

modo.meshgeometry.weakref.WeakKeyDictionary().clear(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.WeakKeyDictionary().copy(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().fromkeys(cls,iterable,value)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.WeakKeyDictionary().get(self,key,default)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().has_key(self,key)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().items(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().iteritems(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().iterkeyrefs(self)

type: instancemethod

doc: Return an iterator that yields the weak references to the keys. The references are not guaranteed to be 'live' at the time they are used, so the result of calling the references needs to be checked before being used. This can be used to avoid creating references that will cause the garbage collector to keep the keys around longer than needed.

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().iterkeys(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().itervalues(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().keyrefs(self)

type: instancemethod

doc: Return a list of weak references to the keys. The references are not guaranteed to be 'live' at the time they are used, so the result of calling the references needs to be checked before being used. This can be used to avoid creating references that will cause the garbage collector to keep the keys around longer than needed.

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().keys(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().pop(self,key)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().popitem(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().setdefault(self,key,default)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().update(self,dict)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakKeyDictionary().values(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.WeakSet

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_weakrefset.pyc

modo.meshgeometry.weakref.WeakSet._apply(self,other,method)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet._commit_removals(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.add(self,item)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.clear(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.copy(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.difference(self,other)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.difference_update(self,other)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.discard(self,item)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.intersection(self,other)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.intersection_update(self,other)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.isdisjoint(self,other)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.issubset(self,other)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.issuperset(self,other)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.pop(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.remove(self,item)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.symmetric_difference(self,other)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.symmetric_difference_update(self,other)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.union(self,other)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakSet.update(self,other)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_weakrefset.py

modo.meshgeometry.weakref.WeakValueDictionary()

type: classobj

doc: Mapping class that references values weakly. Entries in the dictionary will be discarded when no strong reference to the value exists anymore

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\weakref.pyc

modo.meshgeometry.weakref.WeakValueDictionary().clear(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.WeakValueDictionary().copy(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().fromkeys(cls,iterable,value)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.WeakValueDictionary().get(self,key,default)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().has_key(self,key)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().items(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().iteritems(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().iterkeys(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().itervaluerefs(self)

type: instancemethod

doc: Return an iterator that yields the weak references to the values. The references are not guaranteed to be 'live' at the time they are used, so the result of calling the references needs to be checked before being used. This can be used to avoid creating references that will cause the garbage collector to keep the values around longer than needed.

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().itervalues(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().keys(self)

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\UserDict.py

modo.meshgeometry.weakref.WeakValueDictionary().pop(self,key)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().popitem(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().setdefault(self,key,default)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().update(self,dict)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().valuerefs(self)

type: instancemethod

doc: Return a list of weak references to the values. The references are not guaranteed to be 'live' at the time they are used, so the result of calling the references needs to be checked before being used. This can be used to avoid creating references that will cause the garbage collector to keep the values around longer than needed.

file: .\Lib\weakref.py

modo.meshgeometry.weakref.WeakValueDictionary().values(self)

type: instancemethod

file: .\Lib\weakref.py

modo.meshgeometry.WeightMap

type: type

doc: Provides access to weight map values. example:: scene = modo.scene.current() # Get the first selected Mesh mesh = scene.selectedByType("mesh")[0] # Get the weight maps object vmaps = mesh.geometry.vmaps.weight_maps if vmaps: # Get the first weight map found weightMap = vmaps[0] # Set and get values weightMap[0] = 0.333 print weightMap[0] # Iterate and print all weight values if weightMap: for index, weight in enumerate(weightMap): print index, weight

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.WeightMap._accessor

type: property

modo.meshgeometry.WeightMap._WeightMap__null(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.WeightMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.meshgeometry.WeightMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.WeightMap.fromMesh(cls,geometry,accessor,ID,map_type,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.meshgeometry.WeightMap.id

type: property

modo.meshgeometry.WeightMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.MeshMaps

type: type

doc: This module provides access to the various map types that a mesh holds. example:: # By index myMap = geo.vmaps[0] # From string myMap = geo.vmaps['MyMap'] # From string with wildcard myMap = geo.vmaps['MyMap*'] # Get the first morph map if any and change vertex 36 for morph in geo.vmaps.morphMaps[0:1]: morph[36] = (0, 0, 0) # Update changes on the mesh geo.setMeshEdits() Note: to remove a vertex map, use the Remove method of the accessor for now:: myMap.accessor.Remove()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps._getitem(self,index,cls)

type: instancemethod

doc: General access for angular brackets

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps._MeshMaps__classFromSymbol

type: function

doc: Returns the class that corresponds to the given symbol :param lx.symbol symbol: VMap symbol, for example lx.symbol.i_VMAP_MORPH :returns: Class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps._MeshMaps__poll(self,types_list)

type: instancemethod

doc: Enumerates and returns information about the mesh. :param list types_list: optional list of symbols (lx.symbol.i_VMAP_WEIGHT etc.) :returns: List of dictionaries with fields "name", "type_name", "ID" and "map_type"

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.MeshMaps.addMap(self,mapType,name)

type: instancemethod

doc: Add a new map :arg string name: Name :returns: New map

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.addMorphMap(self,name,static)

type: instancemethod

doc: Add a morph map :arg string name: Name :arg bool static: Creates a static (absolute) morph map if true and relative one if false :returns MorphMap:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.addPickMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.addRGBAMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.addRGBMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.addSubdivMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.addUVMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.addVectorMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.addVertexNormalMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.addWeightMap(self,name,initValue)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.edgePickMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.getMapsByType(self,types_list)

type: instancemethod

doc: :param types_list: List of lx.symbol types. If it is None, all map types will be retrieved :type types_list: list :returns: tuple containing the requested map objects of this mesh

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.internalMesh

type: property

doc: :getter: returns the wrapped lx.object.Mesh object

modo.MeshMaps.morphMaps

type: property

doc: :getter: Returns a list of morph maps

modo.MeshMaps.pickMaps

type: property

doc: :getter: Returns a list of pick maps (aka selection sets)

modo.MeshMaps.rgbaMaps

type: property

doc: :getter: Returns a list of RGBA maps

modo.MeshMaps.rgbMaps

type: property

doc: :getter: Returns a list of RGB maps

modo.MeshMaps.tangentBasisMap(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshMaps.uvMaps

type: property

doc: :getter: Returns a list of uv maps

modo.MeshMaps.weightMaps

type: property

doc: :getter: Returns a list of weight maps

modo.MeshPolygon

type: type

doc: Class wrapped around lx.object.Polygon for polygon access.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon._accessor

type: property

modo.MeshPolygon._MeshPolygon__apply_operator(self,func_name,operand)

type: instancemethod

doc: Helper function for operators

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon._MeshPolygon__lookupUVMap(self,uvmap)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon._performSelectionOperation(self,operation)

type: instancemethod

doc: :param basestring operation: 'add', 'replace' or 'deselect'

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.accessor

type: property

doc: :getter: Returns the internal shared PolygonAccessor object of the core SDK (lx.object.Polygon)

modo.MeshPolygon.area

type: property

doc: :getter: Returns the area of this polygon

modo.MeshPolygon.deselect(self)

type: instancemethod

doc: Deselects this polygon

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.edges

type: property

doc: :getter: Returns the :class:`edges` connected to this polygon

modo.MeshPolygon.fromID(cls,ID,geometry)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.fromMesh(cls,index,geometry)

type: instancemethod

doc: Initializes a polygon from a given MeshGeometry object :param index: The polygon index to be obtained :type: int :param geometry: The geometry to obtain the polygon from :type: MeshGeometry :return: An instance of MeshPolygon

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.getIsland(self)

type: instancemethod

doc: Returns the all connected neighbour polygons found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.getTag(self,tagType)

type: instancemethod

doc: Gets a polygon tag :param basestring tagType: Any out of lx.symbol.i_POLYTAG_* :return: Value of the tag

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.getUV(self,vertex,uvmap)

type: instancemethod

doc: Get a UV value pair from a vertex specific to this polygon. :param UVMap uvmap: The UVMap to read the value from :vertex int or MeshVertex: Vertex to read the uv value pair for. Can be a vertex index or a MeshVertex object.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.id

type: property

doc: :getter: Returns the pointer ID of this polygon

modo.MeshPolygon.index

type: property

doc: :getter: Returns the index of this polygon

modo.MeshPolygon.iterTriangles(self,asIndices)

type: instancemethod

doc: :param bool asIndices: Indices are returned if True, MeshVertex instances if False :returns generator object: Tuples consisting of 3 vertices each

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.iterVertexNormals(self)

type: instancemethod

doc: Iterator for vertex normals :return: Generator object that returns a vertex normal per polygon vertex

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.materialTag

type: property

doc: :getter: Get the value of the material tag :setter: Set the value of the material tag, taking a string argument

modo.MeshPolygon.neighbours

type: property

doc: :getter: Returns the neighbour polygons as tuple

modo.MeshPolygon.normal

type: property

doc: :getter: Returns the normal of this polygon face

modo.MeshPolygon.numTriangles(self,keepTriangles)

type: instancemethod

doc: :returns: The number of triangles on the polygon

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.numVertices

type: property

doc: :getter: Returns the number of vertices of this polygon

modo.MeshPolygon.remove(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.select(self,replace)

type: instancemethod

doc: Selects this polygon :param bool replace: Deselects all polygons of this mesh before selecting

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.setTag(self,tagType,value)

type: instancemethod

doc: Sets a polygon tag :param basestring tagType: Any out of lx.symbol.i_POLYTAG_* :param value: Value to set

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.setUV(self,values,vertex,uvmap)

type: instancemethod

doc: Set a UV value pair for a vertex specific to this polygon. Splitting UVs off their surrounding connections can be done this way. :param tuple values: A tuple containing the two uv floats to be set :vertex int or MeshVertex: Vertex to write the uv value pair for. Can be a vertex index or a MeshVertex object. :param UVMap uvmap: The UVMap to write the value to. Will look for the first found UV map if None

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.tags(self)

type: instancemethod

doc: List tags of this polygon

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.triangles

type: property

doc: :getter : Returns all triangle vertices as tuple

modo.MeshPolygon.vertexNormal(self,index)

type: instancemethod

doc: :param int index: Vertex index on the polygon :returns tuple: The normal of the vertex

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygon.vertices

type: property

doc: :getter: Returns the connected :class:`vertices` of the polygon

modo.MeshPolygons

type: type

doc: Extension class of the Polygon accessor that adds iteration methods. The vertices of of individual vertices can be accessed through the built-in iterator function or angular brackets example:: mesh, = modo.scene.current().selectedByType("mesh") # Get the number of polygon print "Number of polygons: %i" % len(mesh.geometry.polygons) # Access the first polygon and print it's normal polygon = mesh.geometry.polygons[0] print polygon.normal # Iterates all polygons through a generator object and print it's vertices for polygon in mesh.geometry.polygons: print polygon.vertices

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons._getitem(self,index,cls)

type: instancemethod

doc: General access for angular brackets

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons._performSelectionOperation

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.accessor

type: property

doc: :getter: Returns the internal shared PolygonAccessor object of the core SDK (lx.object.Polygon)

modo.MeshPolygons.addFromPointIndices(self,indices,reversed)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.enumerate(self,mode,visitor,monitor)

type: instancemethod

doc: Enumerate polygons using a visitor :param int mode: lx.symbol.iMARK_ANY :param lxifc.Visitor visitor: Visitor class instance to use :param monitor: Optional monitor (progress bar) to display

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.internalMesh

type: property

doc: :getter: returns the wrapped lx.object.Mesh object

modo.MeshPolygons.iterByIndices(self,poly_list)

type: instancemethod

doc: Iterate over polygons of a given list of indices. Use this if you want to save memory for large meshes. :param poly_list: List of point indices to visit :return: Iterable MeshPolygon generator object example:: for polygon in mesh.geometry.polygons.iterByIndices([1,4,2]): print polygon

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.iterByType(self,polyType)

type: instancemethod

doc: :param string polyType: Value in FACE, CURV, BEZR, SUBD, SPCH, TEXT, PSUB, LINE :returns: Generator object for polygons of specified type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.iterCurves(self)

type: instancemethod

doc: This method currently broken, please use iterByType('CURV') instead :returns: Iterable for curve polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.iterFaces(self)

type: instancemethod

doc: :returns: Iterable for curve polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.iterLines(self)

type: instancemethod

doc: :returns: Iterable for line polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.iterPixarSubdivs(self)

type: instancemethod

doc: :returns: Iterable for pixar subdiv polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.iterSplinePatches(self)

type: instancemethod

doc: :returns: Iterable for spline patch polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.iterSubdivs(self)

type: instancemethod

doc: :returns: Iterable for subdiv polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.iterTexts(self)

type: instancemethod

doc: :returns: Iterable for text polygons

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.new(self,vertices,reversed)

type: instancemethod

doc: Clockwise for normal forward, anti for backwards

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.select(self,polygons,replace)

type: instancemethod

doc: Selects one or multiple polygons of this mesh :param int, list or tuple polygons: index, MeshPolygon, or sequence of indices or MeshPolygon objects. If None, the selection is cleared. :param bool replace: Clears the selection first

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshPolygons.selected

type: property

doc: :getter: Returns the selected polygons as tuple

modo.MeshVertex

type: type

doc: Class representing a single vertex example:: #Supports operators v1 = mesh.geometry.vertices[1] v2 = mesh.geometry.vertices[2] v1 += v2 v1 = v1 - v2

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertex._accessor

type: property

modo.MeshVertex._MeshVertex__performSelectionOp(self,operation,polygon)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertex.accessor

type: property

doc: :getter: Returns the internal shared PointAccessor object of the core SDK (lx.object.Point)

modo.MeshVertex.deselect(self)

type: instancemethod

doc: Deselects this vertex

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertex.fromId(cls,id,geometry)

type: instancemethod

doc: Initializes a vertex from a given MeshGeometry object :param int or long vertex: The index of the vertex to be obtained. If vertex is of type long, it will be looked up as pointer ID. :type: int :param geometry: The geometry to obtain the vertex from :type: MeshGeometry :return: An instance of MeshVertex

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertex.getUVs(self,uvmap)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertex.id

type: property

doc: :getter: Returns the pointer ID of this vertex

modo.MeshVertex.index

type: property

doc: :getter: Returns the index of this vertex

modo.MeshVertex.nextPointByVector(self,direction,minAlign)

type: instancemethod

doc: :param Vector3 direction: A start vector :param float minAlign: A threshold between -1.0 and 1.0. The smaller the value, the bigger the angle range that is considered. :returns MeshVertex: The vertex closest to the given vector direction

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertex.polygons

type: property

doc: :getter: Returns the connected polygons

modo.MeshVertex.position

type: property

doc: Get or set the local position vector as tuple :getter: Returns position as a tuple :setter: Takes an Iterable as input to set the position from

modo.MeshVertex.remove(self)

type: instancemethod

doc: Removes this vertex from the mesh

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertex.select(self,polygon,replace)

type: instancemethod

doc: Selects this vertex :param MeshPolygon polygon: Selects the vertex specific to this polygon, needed for UV selections :param bool replace: Clears the selection before selecting

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertex.setUVs(self,values,uvmap)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertex.vertices

type: property

doc: :getter: Returns the connected vertices

modo.MeshVertex.x

type: property

doc: :getter: Returns the x position :setter: Takes a float value to set the x position from

modo.MeshVertex.y

type: property

doc: :getter: Returns the y position :setter: Takes a float value to set the y position from

modo.MeshVertex.z

type: property

doc: :getter: Returns the z position :setter: Takes a float value to set the z position from

modo.MeshVertices

type: type

doc: Extension class of the point accessor that adds iteration methods. The individual vertex objects can be accessed through the built-in iterator function or angular brackets example:: # Get the vertex count print "Number of vertices: %i" % len(mesh.geometry.vertices) # Access first vertex print mesh.geometry.vertices[0] # Iterates all vertices through a generator object for vertex in mesh.geometry.vertices: print vertex :param mesh: Input mesh to obtain PointAccessor from :param parent: MeshGeometry parent object

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertices._getitem(self,index,cls)

type: instancemethod

doc: General access for angular brackets

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertices._vertexSelectionOperation

type: function

doc: :param int operation: 0=select(add), 1=select(replace), 2=deselect, 3=clear

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertices.enumerate(self,mode,visitor,monitor)

type: instancemethod

doc: Enumerate vertices using a visitor :param int mode: lx.symbol.iMARK_ANY :param lxifc.Visitor visitor: Visitor class instance to use :param monitor: Optional monitor (progress bar) to display

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertices.internalMesh

type: property

doc: :getter: returns the wrapped lx.object.Mesh object

modo.MeshVertices.iterByList(self,vertex_list)

type: instancemethod

doc: Iterate over vertices of a given list of point indices. :return: Iterable MeshVertices generator object :param vertex_list: List of point indices to visit example:: # Iterate all vertices and move them by 0.1 in x for point in mesh.geometry.vertices.iterByList([1,3,6,7]): pos = list(point.Pos()) pos[0] += 0.1 point.SetPos(pos) # Update to see mesh changes mesh.geometry.setMeshEdits()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertices.new(self,position)

type: instancemethod

doc: Adds a new vertex :param tuple: Position :returns MeshVertex: New vertex object

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertices.remove(self,vertices)

type: instancemethod

doc: Removes a single vertex or a list of vertices :param int or list/tuple vertices: Vertices to remove

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertices.select(self,vertices,replace)

type: instancemethod

doc: Selects one or multiple vertices of this mesh :param int, list or tuple vertices: index, MeshVertex, or sequence of indices or MeshVertex objects. If None, the selection is cleared. :param bool replace: Clears the selection first

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MeshVertices.selected

type: property

doc: :getter: Returns the currently selected vertices (tuple)

modo.MorphMap

type: type

doc: example:: # Get first morph map if exists for morph in geo.vmaps.morphMaps[:1]: # Set position for vertex 10 morph[10] = (1,2,3) # Update mesh geo.setMeshEdits()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MorphMap._accessor

type: property

modo.MorphMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.MorphMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MorphMap.fromMesh(cls)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MorphMap.getAbsolutePosition(self,index)

type: instancemethod

doc: Gets the absolute position instead of the relative position :param int index: Vertex index to read :returns tuple: position values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.MorphMap.id

type: property

modo.MorphMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.MorphMap.setAbsolutePosition(self,index,value)

type: instancemethod

doc: Sets the absolute position instead of the relative position :param int index: Vertex index to change :param tuple: xyz values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.mprop

type: module

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.mprop._cleanup

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.mprop._cleanup_lock

type: lock

doc: A lock object is a synchronization primitive. To create a lock, call the PyThread_allocate_lock() function. Methods are: acquire() -- lock the lock, possibly blocking until it can be obtained release() -- unlock of the lock locked() -- test whether the lock is currently locked A lock is not owned by the thread that locked it; another thread may unlock it. A thread attempting to lock a lock that it has already locked will block until another thread unlocks it. Deadlocks may ensue.

modo.mprop._getattr

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.mprop.imp

type: module

doc: This module provides the components needed to build your own __import__ function. Undocumented functions are obsolete.

modo.mprop.imp.acquire_lock()

type: builtin_function_or_method

doc: acquire_lock() -> None Acquires the interpreter's import lock for the current thread. This lock should be used by import hooks to ensure thread-safety when importing modules. On platforms without threads, this function does nothing.

modo.mprop.imp.C_BUILTIN

type: int

modo.mprop.imp.C_EXTENSION

type: int

modo.mprop.imp.find_module()

type: builtin_function_or_method

doc: find_module(name, [path]) -> (file, filename, (suffix, mode, type)) Search for a module. If path is omitted or None, search for a built-in, frozen or special module and continue search in sys.path. The module name cannot contain '.'; to search for a submodule of a package, pass the submodule name and the package's __path__.

modo.mprop.imp.get_frozen_object()

type: builtin_function_or_method

modo.mprop.imp.get_magic()

type: builtin_function_or_method

doc: get_magic() -> string Return the magic number for .pyc or .pyo files.

modo.mprop.imp.get_suffixes()

type: builtin_function_or_method

doc: get_suffixes() -> [(suffix, mode, type), ...] Return a list of (suffix, mode, type) tuples describing the files that find_module() looks for.

modo.mprop.imp.IMP_HOOK

type: int

modo.mprop.imp.init_builtin()

type: builtin_function_or_method

modo.mprop.imp.init_frozen()

type: builtin_function_or_method

modo.mprop.imp.is_builtin()

type: builtin_function_or_method

modo.mprop.imp.is_frozen()

type: builtin_function_or_method

modo.mprop.imp.load_compiled()

type: builtin_function_or_method

modo.mprop.imp.load_dynamic()

type: builtin_function_or_method

modo.mprop.imp.load_module()

type: builtin_function_or_method

doc: load_module(name, file, filename, (suffix, mode, type)) -> module Load a module, given information returned by find_module(). The module name must include the full package name, if any.

modo.mprop.imp.load_package()

type: builtin_function_or_method

modo.mprop.imp.load_source()

type: builtin_function_or_method

modo.mprop.imp.lock_held()

type: builtin_function_or_method

doc: lock_held() -> boolean Return True if the import lock is currently held, else False. On platforms without threads, return False.

modo.mprop.imp.new_module()

type: builtin_function_or_method

doc: new_module(name) -> module Create a new module. Do not enter it in sys.modules. The module name must include the full package name, if any.

modo.mprop.imp.NullImporter

type: type

doc: Null importer object

    modo.mprop.imp.NullImporter contents:
  • modo.mprop.imp.NullImporter.__class__
  • modo.mprop.imp.NullImporter.__delattr__
  • modo.mprop.imp.NullImporter.__doc__
  • modo.mprop.imp.NullImporter.__format__
  • modo.mprop.imp.NullImporter.__getattribute__
  • modo.mprop.imp.NullImporter.__hash__
  • modo.mprop.imp.NullImporter.__init__
  • modo.mprop.imp.NullImporter.__new__
  • modo.mprop.imp.NullImporter.__reduce__
  • modo.mprop.imp.NullImporter.__reduce_ex__
  • modo.mprop.imp.NullImporter.__repr__
  • modo.mprop.imp.NullImporter.__setattr__
  • modo.mprop.imp.NullImporter.__sizeof__
  • modo.mprop.imp.NullImporter.__str__
  • modo.mprop.imp.NullImporter.__subclasshook__
  • modo.mprop.imp.NullImporter.find_module

modo.mprop.imp.NullImporter.find_module()

type: method_descriptor

doc: Always return None

modo.mprop.imp.PKG_DIRECTORY

type: int

modo.mprop.imp.PY_CODERESOURCE

type: int

modo.mprop.imp.PY_COMPILED

type: int

modo.mprop.imp.PY_FROZEN

type: int

modo.mprop.imp.PY_RESOURCE

type: int

modo.mprop.imp.PY_SOURCE

type: int

modo.mprop.imp.release_lock()

type: builtin_function_or_method

doc: release_lock() -> None Release the interpreter's import lock. On platforms without threads, this function does nothing.

modo.mprop.imp.reload()

type: builtin_function_or_method

doc: reload(module) -> module Reload the module. The module must have been successfully imported before.

modo.mprop.imp.SEARCH_ERROR

type: int

modo.mprop.init

type: function

doc: Initialize the module-level properties/descriptors for the module that this function is being called from. Or, if a globals dictionary is passed, initialize the module-level properties/descriptors for the module that those globals came from. See the readme for more documentation.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.mprop.isdescriptor

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.mprop.mproperty

type: type

doc: Use this descriptor as a decorator in the same way that you would use 'property', but only apply it to module-level functions, and watch as your module gains properties!

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.mprop.mproperty.deleter(self,delete)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.mprop.mproperty.doc

type: member_descriptor

modo.mprop.mproperty.fdel

type: member_descriptor

modo.mprop.mproperty.fget

type: member_descriptor

modo.mprop.mproperty.fset

type: member_descriptor

modo.mprop.mproperty.getter(self,get)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.mprop.mproperty.setter(self,set)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mprop.py

modo.mprop.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.mprop.sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.mprop.sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.mprop.sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.mprop.sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.sys.api_version

type: int

modo.mprop.sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.sys.byteorder

type: str

modo.mprop.sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.mprop.sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.mprop.sys.copyright

type: str

modo.mprop.sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.mprop.sys.dllhandle

type: long

modo.mprop.sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.mprop.sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.mprop.sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.mprop.sys.exc_type

type: type

doc: Inappropriate argument type.

    modo.mprop.sys.exc_type contents:
  • modo.mprop.sys.exc_type.__class__
  • modo.mprop.sys.exc_type.__delattr__
  • modo.mprop.sys.exc_type.__dict__
  • modo.mprop.sys.exc_type.__doc__
  • modo.mprop.sys.exc_type.__format__
  • modo.mprop.sys.exc_type.__getattribute__
  • modo.mprop.sys.exc_type.__getitem__
  • modo.mprop.sys.exc_type.__getslice__
  • modo.mprop.sys.exc_type.__hash__
  • modo.mprop.sys.exc_type.__init__
  • modo.mprop.sys.exc_type.__new__
  • modo.mprop.sys.exc_type.__reduce__
  • modo.mprop.sys.exc_type.__reduce_ex__
  • modo.mprop.sys.exc_type.__repr__
  • modo.mprop.sys.exc_type.__setattr__
  • modo.mprop.sys.exc_type.__setstate__
  • modo.mprop.sys.exc_type.__sizeof__
  • modo.mprop.sys.exc_type.__str__
  • modo.mprop.sys.exc_type.__subclasshook__
  • modo.mprop.sys.exc_type.__unicode__
  • modo.mprop.sys.exc_type.args
  • modo.mprop.sys.exc_type.message

modo.mprop.sys.exc_type.args

type: getset_descriptor

modo.mprop.sys.exc_type.message

type: getset_descriptor

modo.mprop.sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.mprop.sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.mprop.sys.exec_prefix

type: str

modo.mprop.sys.executable

type: str

modo.mprop.sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.mprop.sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.mprop.sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.mprop.sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.mprop.sys.float_repr_style

type: str

modo.mprop.sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.mprop.sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.mprop.sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.mprop.sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.mprop.sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.mprop.sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.mprop.sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.mprop.sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.mprop.sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.mprop.sys.hexversion

type: int

modo.mprop.sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.mprop.sys.maxint

type: int

modo.mprop.sys.maxsize

type: long

modo.mprop.sys.maxunicode

type: int

modo.mprop.sys.meta_path

type: list
modo.mprop.sys.modules type: dict

modo.mprop.sys.modules.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mprop.sys.modules.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mprop.sys.modules.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.sys.modules.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.sys.modules.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.sys.modules.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.sys.modules.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.sys.modules.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.sys.modules.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.sys.modules.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mprop.sys.modules.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.sys.modules.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.sys.modules.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.sys.modules.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.sys.modules.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mprop.sys.modules.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.sys.modules.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.sys.modules.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.sys.path

type: list

modo.mprop.sys.path_hooks

type: list
modo.mprop.sys.path_importer_cache type: dict

modo.mprop.sys.path_importer_cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mprop.sys.path_importer_cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mprop.sys.path_importer_cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.sys.path_importer_cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.sys.path_importer_cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.sys.path_importer_cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.sys.path_importer_cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.sys.path_importer_cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.sys.path_importer_cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.sys.path_importer_cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mprop.sys.path_importer_cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.sys.path_importer_cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.sys.path_importer_cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.sys.path_importer_cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.sys.path_importer_cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mprop.sys.path_importer_cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.sys.path_importer_cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.sys.path_importer_cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.sys.platform

type: str

modo.mprop.sys.prefix

type: str

modo.mprop.sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.mprop.sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.mprop.sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.mprop.sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.mprop.sys.stderr

type: SESysStdErr

modo.mprop.sys.stdin

type: SESysStdIn

modo.mprop.sys.stdout

type: SESysStdOut

modo.mprop.sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.sys.version

type: str

modo.mprop.sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.mprop.sys.warnoptions

type: list

modo.mprop.sys.winver

type: str
modo.mprop.threading

type: module

doc: Thread module emulating a subset of Java's threading model.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\threading.pyc

modo.mprop.threading._active type: dict

modo.mprop.threading._active.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mprop.threading._active.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mprop.threading._active.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.threading._active.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.threading._active.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.threading._active.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.threading._active.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.threading._active.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.threading._active.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.threading._active.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mprop.threading._active.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.threading._active.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.threading._active.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.threading._active.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.threading._active.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mprop.threading._active.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.threading._active.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.threading._active.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.threading._active_limbo_lock

type: lock

doc: A lock object is a synchronization primitive. To create a lock, call the PyThread_allocate_lock() function. Methods are: acquire() -- lock the lock, possibly blocking until it can be obtained release() -- unlock of the lock locked() -- test whether the lock is currently locked A lock is not owned by the thread that locked it; another thread may unlock it. A thread attempting to lock a lock that it has already locked will block until another thread unlocks it. Deadlocks may ensue.

modo.mprop.threading._after_fork

type: function

file: .\Lib\threading.py

modo.mprop.threading._allocate_lock()

type: builtin_function_or_method

doc: allocate_lock() -> lock object (allocate() is an obsolete synonym) Create a new lock object. See help(LockType) for information about locks.

modo.mprop.threading._BoundedSemaphore

type: type

doc: Semaphore that checks that # releases is <= # acquires

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\threading.pyc

    modo.mprop.threading._BoundedSemaphore contents:
  • modo.mprop.threading._BoundedSemaphore.__class__
  • modo.mprop.threading._BoundedSemaphore.__delattr__
  • modo.mprop.threading._BoundedSemaphore.__dict__
  • modo.mprop.threading._BoundedSemaphore.__doc__
  • modo.mprop.threading._BoundedSemaphore.__enter__
  • modo.mprop.threading._BoundedSemaphore.__exit__
  • modo.mprop.threading._BoundedSemaphore.__format__
  • modo.mprop.threading._BoundedSemaphore.__getattribute__
  • modo.mprop.threading._BoundedSemaphore.__hash__
  • modo.mprop.threading._BoundedSemaphore.__init__
  • modo.mprop.threading._BoundedSemaphore.__module__
  • modo.mprop.threading._BoundedSemaphore.__new__
  • modo.mprop.threading._BoundedSemaphore.__reduce__
  • modo.mprop.threading._BoundedSemaphore.__reduce_ex__
  • modo.mprop.threading._BoundedSemaphore.__repr__
  • modo.mprop.threading._BoundedSemaphore.__setattr__
  • modo.mprop.threading._BoundedSemaphore.__sizeof__
  • modo.mprop.threading._BoundedSemaphore.__str__
  • modo.mprop.threading._BoundedSemaphore.__subclasshook__
  • modo.mprop.threading._BoundedSemaphore.__weakref__
  • modo.mprop.threading._BoundedSemaphore._note
  • modo.mprop.threading._BoundedSemaphore.acquire
  • modo.mprop.threading._BoundedSemaphore.release

modo.mprop.threading._BoundedSemaphore._note(self,format)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._BoundedSemaphore.acquire(self,blocking)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._BoundedSemaphore.release(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Condition

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\threading.pyc

modo.mprop.threading._Condition._acquire_restore(self,x)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Condition._is_owned(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Condition._note(self,format)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Condition._release_save(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Condition.notify(self,n)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Condition.notify_all(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Condition.notifyAll(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Condition.wait(self,timeout)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._counter

type: int
modo.mprop.threading._DummyThread

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\threading.pyc

modo.mprop.threading._DummyThread._block

type: property

modo.mprop.threading._DummyThread._note(self,format)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread._reset_internal_locks(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread._set_daemon(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread._set_ident(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread._Thread__bootstrap(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread._Thread__bootstrap_inner(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread._Thread__delete(self)

type: instancemethod

doc: Remove current thread from the dict of currently running threads.

file: .\Lib\threading.py

modo.mprop.threading._DummyThread._Thread__exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.mprop.threading._DummyThread._Thread__exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.mprop.threading._DummyThread._Thread__initialized

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.threading._DummyThread._Thread__stop(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread.daemon

type: property

modo.mprop.threading._DummyThread.getName(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread.ident

type: property

modo.mprop.threading._DummyThread.is_alive(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread.isAlive(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread.isDaemon(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread.join(self,timeout)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread.name

type: property

modo.mprop.threading._DummyThread.run(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread.setDaemon(self,daemonic)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread.setName(self,name)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._DummyThread.start(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._enumerate

type: function

file: .\Lib\threading.py

modo.mprop.threading._Event

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\threading.pyc

modo.mprop.threading._Event._note(self,format)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Event._reset_internal_locks(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Event.clear(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Event.is_set(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Event.isSet(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Event.set(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Event.wait(self,timeout)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._format_exc

type: function

doc: Like print_exc() but return a string.

file: u:\Luxology\source\extra\python\python2.7\lib\traceback.py

modo.mprop.threading._get_ident()

type: builtin_function_or_method

doc: get_ident() -> integer Return a non-zero integer that uniquely identifies the current thread amongst other threads that exist simultaneously. This may be used to identify per-thread resources. Even though on some platforms threads identities may appear to be allocated consecutive numbers starting at 1, this behavior should not be relied upon, and the number should be seen purely as a magic cookie. A thread's identity may be reused for another thread after it exits.

modo.mprop.threading._limbo type: dict

modo.mprop.threading._limbo.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mprop.threading._limbo.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mprop.threading._limbo.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.threading._limbo.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.threading._limbo.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.threading._limbo.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.threading._limbo.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.threading._limbo.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.threading._limbo.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.threading._limbo.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mprop.threading._limbo.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.threading._limbo.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.threading._limbo.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.threading._limbo.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.threading._limbo.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mprop.threading._limbo.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.threading._limbo.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.threading._limbo.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.threading._MainThread

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\threading.pyc

modo.mprop.threading._MainThread._block

type: property

modo.mprop.threading._MainThread._exitfunc(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread._note(self,format)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread._reset_internal_locks(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread._set_daemon(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread._set_ident(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread._Thread__bootstrap(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread._Thread__bootstrap_inner(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread._Thread__delete(self)

type: instancemethod

doc: Remove current thread from the dict of currently running threads.

file: .\Lib\threading.py

modo.mprop.threading._MainThread._Thread__exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.mprop.threading._MainThread._Thread__exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.mprop.threading._MainThread._Thread__initialized

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.threading._MainThread._Thread__stop(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread.daemon

type: property

modo.mprop.threading._MainThread.getName(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread.ident

type: property

modo.mprop.threading._MainThread.is_alive(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread.isAlive(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread.isDaemon(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread.join(self,timeout)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread.name

type: property

modo.mprop.threading._MainThread.run(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread.setDaemon(self,daemonic)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread.setName(self,name)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._MainThread.start(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._newname

type: function

file: .\Lib\threading.py

modo.mprop.threading._pickSomeNonDaemonThread

type: function

file: .\Lib\threading.py

modo.mprop.threading._profile_hook

type: NoneType

modo.mprop.threading._RLock

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\threading.pyc

modo.mprop.threading._RLock._acquire_restore(self,count_owner)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._RLock._is_owned(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._RLock._note(self,format)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._RLock._release_save(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._RLock.acquire(self,blocking)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._RLock.release(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Semaphore

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\threading.pyc

    modo.mprop.threading._Semaphore contents:
  • modo.mprop.threading._Semaphore.__class__
  • modo.mprop.threading._Semaphore.__delattr__
  • modo.mprop.threading._Semaphore.__dict__
  • modo.mprop.threading._Semaphore.__doc__
  • modo.mprop.threading._Semaphore.__enter__
  • modo.mprop.threading._Semaphore.__exit__
  • modo.mprop.threading._Semaphore.__format__
  • modo.mprop.threading._Semaphore.__getattribute__
  • modo.mprop.threading._Semaphore.__hash__
  • modo.mprop.threading._Semaphore.__init__
  • modo.mprop.threading._Semaphore.__module__
  • modo.mprop.threading._Semaphore.__new__
  • modo.mprop.threading._Semaphore.__reduce__
  • modo.mprop.threading._Semaphore.__reduce_ex__
  • modo.mprop.threading._Semaphore.__repr__
  • modo.mprop.threading._Semaphore.__setattr__
  • modo.mprop.threading._Semaphore.__sizeof__
  • modo.mprop.threading._Semaphore.__str__
  • modo.mprop.threading._Semaphore.__subclasshook__
  • modo.mprop.threading._Semaphore.__weakref__
  • modo.mprop.threading._Semaphore._note
  • modo.mprop.threading._Semaphore.acquire
  • modo.mprop.threading._Semaphore.release

modo.mprop.threading._Semaphore._note(self,format)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Semaphore.acquire(self,blocking)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Semaphore.release(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._shutdown(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._sleep()

type: builtin_function_or_method

doc: sleep(seconds) Delay execution for a given number of seconds. The argument may be a floating point number for subsecond precision.

modo.mprop.threading._start_new_thread()

type: builtin_function_or_method

doc: start_new_thread(function, args[, kwargs]) (start_new() is an obsolete synonym) Start a new thread and return its identifier. The thread will call the function with positional arguments from the tuple args and keyword arguments taken from the optional dictionary kwargs. The thread exits when the function returns; the return value is ignored. The thread will also exit when the function raises an unhandled exception; a stack trace will be printed unless the exception is SystemExit.

modo.mprop.threading._sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.mprop.threading._sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.mprop.threading._sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.mprop.threading._sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.mprop.threading._sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.threading._sys.api_version

type: int

modo.mprop.threading._sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.threading._sys.byteorder

type: str

modo.mprop.threading._sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.mprop.threading._sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.mprop.threading._sys.copyright

type: str

modo.mprop.threading._sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.mprop.threading._sys.dllhandle

type: long

modo.mprop.threading._sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.threading._sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.mprop.threading._sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.mprop.threading._sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.mprop.threading._sys.exc_type

type: type

doc: Inappropriate argument type.

    modo.mprop.threading._sys.exc_type contents:
  • modo.mprop.threading._sys.exc_type.__class__
  • modo.mprop.threading._sys.exc_type.__delattr__
  • modo.mprop.threading._sys.exc_type.__dict__
  • modo.mprop.threading._sys.exc_type.__doc__
  • modo.mprop.threading._sys.exc_type.__format__
  • modo.mprop.threading._sys.exc_type.__getattribute__
  • modo.mprop.threading._sys.exc_type.__getitem__
  • modo.mprop.threading._sys.exc_type.__getslice__
  • modo.mprop.threading._sys.exc_type.__hash__
  • modo.mprop.threading._sys.exc_type.__init__
  • modo.mprop.threading._sys.exc_type.__new__
  • modo.mprop.threading._sys.exc_type.__reduce__
  • modo.mprop.threading._sys.exc_type.__reduce_ex__
  • modo.mprop.threading._sys.exc_type.__repr__
  • modo.mprop.threading._sys.exc_type.__setattr__
  • modo.mprop.threading._sys.exc_type.__setstate__
  • modo.mprop.threading._sys.exc_type.__sizeof__
  • modo.mprop.threading._sys.exc_type.__str__
  • modo.mprop.threading._sys.exc_type.__subclasshook__
  • modo.mprop.threading._sys.exc_type.__unicode__
  • modo.mprop.threading._sys.exc_type.args
  • modo.mprop.threading._sys.exc_type.message

modo.mprop.threading._sys.exc_type.args

type: getset_descriptor

modo.mprop.threading._sys.exc_type.message

type: getset_descriptor

modo.mprop.threading._sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.mprop.threading._sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.mprop.threading._sys.exec_prefix

type: str

modo.mprop.threading._sys.executable

type: str

modo.mprop.threading._sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.mprop.threading._sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.mprop.threading._sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.mprop.threading._sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.mprop.threading._sys.float_repr_style

type: str

modo.mprop.threading._sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.mprop.threading._sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.mprop.threading._sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.mprop.threading._sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.mprop.threading._sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.mprop.threading._sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.mprop.threading._sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.mprop.threading._sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.mprop.threading._sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.mprop.threading._sys.hexversion

type: int

modo.mprop.threading._sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.mprop.threading._sys.maxint

type: int

modo.mprop.threading._sys.maxsize

type: long

modo.mprop.threading._sys.maxunicode

type: int

modo.mprop.threading._sys.meta_path

type: list
modo.mprop.threading._sys.modules type: dict

modo.mprop.threading._sys.modules.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mprop.threading._sys.modules.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mprop.threading._sys.modules.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.threading._sys.modules.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.threading._sys.modules.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.threading._sys.modules.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.threading._sys.modules.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.threading._sys.modules.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.threading._sys.modules.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.threading._sys.modules.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mprop.threading._sys.modules.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.threading._sys.modules.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.threading._sys.modules.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.threading._sys.modules.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.threading._sys.modules.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mprop.threading._sys.modules.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.threading._sys.modules.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.threading._sys.modules.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.threading._sys.path

type: list

modo.mprop.threading._sys.path_hooks

type: list
modo.mprop.threading._sys.path_importer_cache type: dict

modo.mprop.threading._sys.path_importer_cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mprop.threading._sys.path_importer_cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mprop.threading._sys.path_importer_cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.threading._sys.path_importer_cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.threading._sys.path_importer_cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.threading._sys.path_importer_cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.threading._sys.path_importer_cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.threading._sys.path_importer_cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.threading._sys.path_importer_cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.threading._sys.path_importer_cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mprop.threading._sys.path_importer_cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.threading._sys.path_importer_cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.threading._sys.path_importer_cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.threading._sys.path_importer_cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.threading._sys.path_importer_cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mprop.threading._sys.path_importer_cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.threading._sys.path_importer_cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.threading._sys.path_importer_cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.threading._sys.platform

type: str

modo.mprop.threading._sys.prefix

type: str

modo.mprop.threading._sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.threading._sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.mprop.threading._sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.mprop.threading._sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.mprop.threading._sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.mprop.threading._sys.stderr

type: SESysStdErr

modo.mprop.threading._sys.stdin

type: SESysStdIn

modo.mprop.threading._sys.stdout

type: SESysStdOut

modo.mprop.threading._sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.threading._sys.version

type: str

modo.mprop.threading._sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.mprop.threading._sys.warnoptions

type: list

modo.mprop.threading._sys.winver

type: str

modo.mprop.threading._test

type: function

file: .\Lib\threading.py

modo.mprop.threading._time()

type: builtin_function_or_method

doc: time() -> floating point number Return the current time in seconds since the Epoch. Fractions of a second may be present if the system clock provides them.

modo.mprop.threading._Timer

type: type

doc: Call a function after a specified number of seconds: t = Timer(30.0, f, args=[], kwargs={}) t.start() t.cancel() # stop the timer's action if it's still waiting

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\threading.pyc

modo.mprop.threading._Timer._block

type: property

modo.mprop.threading._Timer._note(self,format)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer._reset_internal_locks(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer._set_daemon(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer._set_ident(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer._Thread__bootstrap(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer._Thread__bootstrap_inner(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer._Thread__delete(self)

type: instancemethod

doc: Remove current thread from the dict of currently running threads.

file: .\Lib\threading.py

modo.mprop.threading._Timer._Thread__exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.mprop.threading._Timer._Thread__exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.mprop.threading._Timer._Thread__initialized

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.threading._Timer._Thread__stop(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer.cancel(self)

type: instancemethod

doc: Stop the timer if it hasn't finished yet

file: .\Lib\threading.py

modo.mprop.threading._Timer.daemon

type: property

modo.mprop.threading._Timer.getName(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer.ident

type: property

modo.mprop.threading._Timer.is_alive(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer.isAlive(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer.isDaemon(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer.join(self,timeout)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer.name

type: property

modo.mprop.threading._Timer.run(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer.setDaemon(self,daemonic)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer.setName(self,name)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._Timer.start(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading._trace_hook

type: NoneType

modo.mprop.threading._VERBOSE

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.threading._Verbose

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\threading.pyc

    modo.mprop.threading._Verbose contents:
  • modo.mprop.threading._Verbose.__class__
  • modo.mprop.threading._Verbose.__delattr__
  • modo.mprop.threading._Verbose.__dict__
  • modo.mprop.threading._Verbose.__doc__
  • modo.mprop.threading._Verbose.__format__
  • modo.mprop.threading._Verbose.__getattribute__
  • modo.mprop.threading._Verbose.__hash__
  • modo.mprop.threading._Verbose.__init__
  • modo.mprop.threading._Verbose.__module__
  • modo.mprop.threading._Verbose.__new__
  • modo.mprop.threading._Verbose.__reduce__
  • modo.mprop.threading._Verbose.__reduce_ex__
  • modo.mprop.threading._Verbose.__repr__
  • modo.mprop.threading._Verbose.__setattr__
  • modo.mprop.threading._Verbose.__sizeof__
  • modo.mprop.threading._Verbose.__str__
  • modo.mprop.threading._Verbose.__subclasshook__
  • modo.mprop.threading._Verbose.__weakref__
  • modo.mprop.threading._Verbose._note

modo.mprop.threading._Verbose._note(self,format)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.active_count

type: function

file: .\Lib\threading.py

modo.mprop.threading.activeCount

type: function

file: .\Lib\threading.py

modo.mprop.threading.BoundedSemaphore

type: function

file: .\Lib\threading.py

modo.mprop.threading.Condition

type: function

file: .\Lib\threading.py

modo.mprop.threading.current_thread

type: function

file: .\Lib\threading.py

modo.mprop.threading.currentThread

type: function

file: .\Lib\threading.py

modo.mprop.threading.enumerate

type: function

file: .\Lib\threading.py

modo.mprop.threading.Event

type: function

file: .\Lib\threading.py

modo.mprop.threading.local

type: type

doc: Thread-local data

    modo.mprop.threading.local contents:
  • modo.mprop.threading.local.__class__
  • modo.mprop.threading.local.__delattr__
  • modo.mprop.threading.local.__doc__
  • modo.mprop.threading.local.__format__
  • modo.mprop.threading.local.__getattribute__
  • modo.mprop.threading.local.__hash__
  • modo.mprop.threading.local.__init__
  • modo.mprop.threading.local.__new__
  • modo.mprop.threading.local.__reduce__
  • modo.mprop.threading.local.__reduce_ex__
  • modo.mprop.threading.local.__repr__
  • modo.mprop.threading.local.__setattr__
  • modo.mprop.threading.local.__sizeof__
  • modo.mprop.threading.local.__str__
  • modo.mprop.threading.local.__subclasshook__

modo.mprop.threading.Lock()

type: builtin_function_or_method

doc: allocate_lock() -> lock object (allocate() is an obsolete synonym) Create a new lock object. See help(LockType) for information about locks.

modo.mprop.threading.RLock

type: function

file: .\Lib\threading.py

modo.mprop.threading.Semaphore

type: function

file: .\Lib\threading.py

modo.mprop.threading.setprofile

type: function

file: .\Lib\threading.py

modo.mprop.threading.settrace

type: function

file: .\Lib\threading.py

modo.mprop.threading.stack_size()

type: builtin_function_or_method

doc: stack_size([size]) -> size Return the thread stack size used when creating new threads. The optional size argument specifies the stack size (in bytes) to be used for subsequently created threads, and must be 0 (use platform or configured default) or a positive integer value of at least 32,768 (32k). If changing the thread stack size is unsupported, a ThreadError exception is raised. If the specified size is invalid, a ValueError exception is raised, and the stack size is unmodified. 32k bytes currently the minimum supported stack size value to guarantee sufficient stack space for the interpreter itself. Note that some platforms may have particular restrictions on values for the stack size, such as requiring a minimum stack size larger than 32kB or requiring allocation in multiples of the system memory page size - platform documentation should be referred to for more information (4kB pages are common; using multiples of 4096 for the stack size is the suggested approach in the absence of more specific information).

modo.mprop.threading.Thread

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\threading.pyc

modo.mprop.threading.Thread._block

type: property

modo.mprop.threading.Thread._note(self,format)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread._reset_internal_locks(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread._set_daemon(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread._set_ident(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread._Thread__bootstrap(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread._Thread__bootstrap_inner(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread._Thread__delete(self)

type: instancemethod

doc: Remove current thread from the dict of currently running threads.

file: .\Lib\threading.py

modo.mprop.threading.Thread._Thread__exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.mprop.threading.Thread._Thread__exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.mprop.threading.Thread._Thread__initialized

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.threading.Thread._Thread__stop(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread.daemon

type: property

modo.mprop.threading.Thread.getName(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread.ident

type: property

modo.mprop.threading.Thread.is_alive(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread.isAlive(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread.isDaemon(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread.join(self,timeout)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread.name

type: property

modo.mprop.threading.Thread.run(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread.setDaemon(self,daemonic)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread.setName(self,name)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.Thread.start(self)

type: instancemethod

file: .\Lib\threading.py

modo.mprop.threading.ThreadError

type: type

    modo.mprop.threading.ThreadError contents:
  • modo.mprop.threading.ThreadError.__class__
  • modo.mprop.threading.ThreadError.__delattr__
  • modo.mprop.threading.ThreadError.__dict__
  • modo.mprop.threading.ThreadError.__doc__
  • modo.mprop.threading.ThreadError.__format__
  • modo.mprop.threading.ThreadError.__getattribute__
  • modo.mprop.threading.ThreadError.__getitem__
  • modo.mprop.threading.ThreadError.__getslice__
  • modo.mprop.threading.ThreadError.__hash__
  • modo.mprop.threading.ThreadError.__init__
  • modo.mprop.threading.ThreadError.__module__
  • modo.mprop.threading.ThreadError.__new__
  • modo.mprop.threading.ThreadError.__reduce__
  • modo.mprop.threading.ThreadError.__reduce_ex__
  • modo.mprop.threading.ThreadError.__repr__
  • modo.mprop.threading.ThreadError.__setattr__
  • modo.mprop.threading.ThreadError.__setstate__
  • modo.mprop.threading.ThreadError.__sizeof__
  • modo.mprop.threading.ThreadError.__str__
  • modo.mprop.threading.ThreadError.__subclasshook__
  • modo.mprop.threading.ThreadError.__unicode__
  • modo.mprop.threading.ThreadError.__weakref__
  • modo.mprop.threading.ThreadError.args
  • modo.mprop.threading.ThreadError.message

modo.mprop.threading.ThreadError.args

type: getset_descriptor

modo.mprop.threading.ThreadError.message

type: getset_descriptor

modo.mprop.threading.Timer

type: function

file: .\Lib\threading.py

modo.mprop.threading.warnings

type: module

doc: Python part of the warnings subsystem.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\warnings.pyc

modo.mprop.threading.warnings._getaction

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\warnings.py

modo.mprop.threading.warnings._getcategory

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\warnings.py

modo.mprop.threading.warnings._OptionError

type: type

doc: Exception used by option processing helpers.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\warnings.pyc

    modo.mprop.threading.warnings._OptionError contents:
  • modo.mprop.threading.warnings._OptionError.__class__
  • modo.mprop.threading.warnings._OptionError.__delattr__
  • modo.mprop.threading.warnings._OptionError.__dict__
  • modo.mprop.threading.warnings._OptionError.__doc__
  • modo.mprop.threading.warnings._OptionError.__format__
  • modo.mprop.threading.warnings._OptionError.__getattribute__
  • modo.mprop.threading.warnings._OptionError.__getitem__
  • modo.mprop.threading.warnings._OptionError.__getslice__
  • modo.mprop.threading.warnings._OptionError.__hash__
  • modo.mprop.threading.warnings._OptionError.__init__
  • modo.mprop.threading.warnings._OptionError.__module__
  • modo.mprop.threading.warnings._OptionError.__new__
  • modo.mprop.threading.warnings._OptionError.__reduce__
  • modo.mprop.threading.warnings._OptionError.__reduce_ex__
  • modo.mprop.threading.warnings._OptionError.__repr__
  • modo.mprop.threading.warnings._OptionError.__setattr__
  • modo.mprop.threading.warnings._OptionError.__setstate__
  • modo.mprop.threading.warnings._OptionError.__sizeof__
  • modo.mprop.threading.warnings._OptionError.__str__
  • modo.mprop.threading.warnings._OptionError.__subclasshook__
  • modo.mprop.threading.warnings._OptionError.__unicode__
  • modo.mprop.threading.warnings._OptionError.__weakref__
  • modo.mprop.threading.warnings._OptionError.args
  • modo.mprop.threading.warnings._OptionError.message

modo.mprop.threading.warnings._OptionError.args

type: getset_descriptor

modo.mprop.threading.warnings._OptionError.message

type: getset_descriptor

modo.mprop.threading.warnings._processoptions

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\warnings.py

modo.mprop.threading.warnings._setoption

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\warnings.py

modo.mprop.threading.warnings._show_warning

type: function

doc: Hook to write a warning to a file; replace if you like.

file: u:\Luxology\source\extra\python\python2.7\lib\warnings.py

modo.mprop.threading.warnings.catch_warnings

type: type

doc: A context manager that copies and restores the warnings filter upon exiting the context. The 'record' argument specifies whether warnings should be captured by a custom implementation of warnings.showwarning() and be appended to a list returned by the context manager. Otherwise None is returned by the context manager. The objects appended to the list are arguments whose attributes mirror the arguments to showwarning(). The 'module' argument is to specify an alternative module to the module named 'warnings' and imported under that name. This argument is only useful when testing the warnings module itself.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\warnings.pyc

    modo.mprop.threading.warnings.catch_warnings contents:
  • modo.mprop.threading.warnings.catch_warnings.__class__
  • modo.mprop.threading.warnings.catch_warnings.__delattr__
  • modo.mprop.threading.warnings.catch_warnings.__dict__
  • modo.mprop.threading.warnings.catch_warnings.__doc__
  • modo.mprop.threading.warnings.catch_warnings.__enter__
  • modo.mprop.threading.warnings.catch_warnings.__exit__
  • modo.mprop.threading.warnings.catch_warnings.__format__
  • modo.mprop.threading.warnings.catch_warnings.__getattribute__
  • modo.mprop.threading.warnings.catch_warnings.__hash__
  • modo.mprop.threading.warnings.catch_warnings.__init__
  • modo.mprop.threading.warnings.catch_warnings.__module__
  • modo.mprop.threading.warnings.catch_warnings.__new__
  • modo.mprop.threading.warnings.catch_warnings.__reduce__
  • modo.mprop.threading.warnings.catch_warnings.__reduce_ex__
  • modo.mprop.threading.warnings.catch_warnings.__repr__
  • modo.mprop.threading.warnings.catch_warnings.__setattr__
  • modo.mprop.threading.warnings.catch_warnings.__sizeof__
  • modo.mprop.threading.warnings.catch_warnings.__str__
  • modo.mprop.threading.warnings.catch_warnings.__subclasshook__
  • modo.mprop.threading.warnings.catch_warnings.__weakref__

modo.mprop.threading.warnings.default_action

type: str

modo.mprop.threading.warnings.defaultaction

type: str

modo.mprop.threading.warnings.filters

type: list

modo.mprop.threading.warnings.filterwarnings

type: function

doc: Insert an entry into the list of warnings filters (at the front). 'action' -- one of "error", "ignore", "always", "default", "module", or "once" 'message' -- a regex that the warning message must match 'category' -- a class that the warning must be a subclass of 'module' -- a regex that the module name must match 'lineno' -- an integer line number, 0 matches all warnings 'append' -- if true, append to the list of filters

file: u:\Luxology\source\extra\python\python2.7\lib\warnings.py

modo.mprop.threading.warnings.formatwarning

type: function

doc: Function to format a warning the standard way.

file: u:\Luxology\source\extra\python\python2.7\lib\warnings.py

modo.mprop.threading.warnings.linecache

type: module

doc: Cache lines from files. This is intended to read lines from modules imported -- hence if a filename is not found, it will look down the module search path for a file by that name.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\linecache.pyc

modo.mprop.threading.warnings.linecache.cache type: dict

modo.mprop.threading.warnings.linecache.cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mprop.threading.warnings.linecache.cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mprop.threading.warnings.linecache.cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.threading.warnings.linecache.cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.threading.warnings.linecache.cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.threading.warnings.linecache.cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.threading.warnings.linecache.cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.threading.warnings.linecache.cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.threading.warnings.linecache.cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.threading.warnings.linecache.cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mprop.threading.warnings.linecache.cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.threading.warnings.linecache.cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.threading.warnings.linecache.cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.threading.warnings.linecache.cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.threading.warnings.linecache.cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mprop.threading.warnings.linecache.cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.threading.warnings.linecache.cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.threading.warnings.linecache.cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.threading.warnings.linecache.checkcache

type: function

doc: Discard cache entries that are out of date. (This is not checked upon each call!)

file: u:\Luxology\source\extra\python\python2.7\lib\linecache.py

modo.mprop.threading.warnings.linecache.clearcache

type: function

doc: Clear the cache entirely.

file: u:\Luxology\source\extra\python\python2.7\lib\linecache.py

modo.mprop.threading.warnings.linecache.getline

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\linecache.py

modo.mprop.threading.warnings.linecache.getlines

type: function

doc: Get the lines for a file from the cache. Update the cache if it doesn't contain an entry for this file already.

file: u:\Luxology\source\extra\python\python2.7\lib\linecache.py

modo.mprop.threading.warnings.linecache.os

type: module

doc: OS routines for Mac, NT, or Posix depending on what system we're on. This exports: - all functions from posix, nt, os2, or ce, e.g. unlink, stat, etc. - os.path is one of the modules posixpath, or ntpath - os.name is 'posix', 'nt', 'os2', 'ce' or 'riscos' - os.curdir is a string representing the current directory ('.' or ':') - os.pardir is a string representing the parent directory ('..' or '::') - os.sep is the (or a most common) pathname separator ('/' or ':' or '\\') - os.extsep is the extension separator ('.' or '/') - os.altsep is the alternate pathname separator (None or '/') - os.pathsep is the component separator used in $PATH etc - os.linesep is the line separator in text files ('\r' or '\n' or '\r\n') - os.defpath is the default search path for executables - os.devnull is the file path of the null device ('/dev/null', etc.) Programs that import and use 'os' stand a better chance of being portable between different platforms. Of course, they must then only use functions that are defined by all platforms (e.g., unlink and opendir), and leave all pathname manipulation to os.path (e.g., split and join).

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\os.pyc

modo.mprop.threading.warnings.linecache.os._copy_reg

type: module

doc: Helper to provide extensibility for pickle/cPickle. This is only useful to add pickle support for extension types defined in C, not for instances of user-defined classes.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\copy_reg.pyc

modo.mprop.threading.warnings.linecache.os._Environ()

type: classobj

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\os.pyc

modo.mprop.threading.warnings.linecache.os._execvpe

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os._exists

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os._exit()

type: builtin_function_or_method

doc: _exit(status) Exit to the system with specified status, without normal exit processing.

modo.mprop.threading.warnings.linecache.os._get_exports_list

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os._make_stat_result

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os._make_statvfs_result

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os._pickle_stat_result

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os._pickle_statvfs_result

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.abort()

type: builtin_function_or_method

doc: abort() -> does not return! Abort the interpreter immediately. This 'dumps core' or otherwise fails in the hardest way possible on the hosting operating system.

modo.mprop.threading.warnings.linecache.os.access()

type: builtin_function_or_method

doc: access(path, mode) -> True if granted, False otherwise Use the real uid/gid to test for access to a path. Note that most operations will use the effective uid/gid, therefore this routine can be used in a suid/sgid environment to test if the invoking user has the specified access to the path. The mode argument can be F_OK to test existence, or the inclusive-OR of R_OK, W_OK, and X_OK.

modo.mprop.threading.warnings.linecache.os.altsep

type: str

modo.mprop.threading.warnings.linecache.os.chdir()

type: builtin_function_or_method

doc: chdir(path) Change the current working directory to the specified path.

modo.mprop.threading.warnings.linecache.os.chmod()

type: builtin_function_or_method

doc: chmod(path, mode) Change the access permissions of a file.

modo.mprop.threading.warnings.linecache.os.close()

type: builtin_function_or_method

doc: close(fd) Close a file descriptor (for low level IO).

modo.mprop.threading.warnings.linecache.os.closerange()

type: builtin_function_or_method

doc: closerange(fd_low, fd_high) Closes all file descriptors in [fd_low, fd_high), ignoring errors.

modo.mprop.threading.warnings.linecache.os.curdir

type: str

modo.mprop.threading.warnings.linecache.os.defpath

type: str

modo.mprop.threading.warnings.linecache.os.devnull

type: str

modo.mprop.threading.warnings.linecache.os.dup()

type: builtin_function_or_method

doc: dup(fd) -> fd2 Return a duplicate of a file descriptor.

modo.mprop.threading.warnings.linecache.os.dup2()

type: builtin_function_or_method

doc: dup2(old_fd, new_fd) Duplicate file descriptor.

modo.mprop.threading.warnings.linecache.os.environ

type: instance

modo.mprop.threading.warnings.linecache.os.errno

type: module

doc: This module makes available standard errno system symbols. The value of each symbol is the corresponding integer value, e.g., on most systems, errno.ENOENT equals the integer 2. The dictionary errno.errorcode maps numeric codes to symbol names, e.g., errno.errorcode[2] could be the string 'ENOENT'. Symbols that are not relevant to the underlying system are not defined. To map error codes to error messages, use the function os.strerror(), e.g. os.strerror(2) could return 'No such file or directory'.

modo.mprop.threading.warnings.linecache.os.error

type: type

doc: OS system call failed.

modo.mprop.threading.warnings.linecache.os.execl

type: function

doc: execl(file, *args) Execute the executable file with argument list args, replacing the current process.

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.execle

type: function

doc: execle(file, *args, env) Execute the executable file with argument list args and environment env, replacing the current process.

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.execlp

type: function

doc: execlp(file, *args) Execute the executable file (which is searched for along $PATH) with argument list args, replacing the current process.

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.execlpe

type: function

doc: execlpe(file, *args, env) Execute the executable file (which is searched for along $PATH) with argument list args and environment env, replacing the current process.

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.execv()

type: builtin_function_or_method

doc: execv(path, args) Execute an executable path with arguments, replacing current process. path: path of executable file args: tuple or list of strings

modo.mprop.threading.warnings.linecache.os.execve()

type: builtin_function_or_method

doc: execve(path, args, env) Execute a path with arguments and environment, replacing current process. path: path of executable file args: tuple or list of arguments env: dictionary of strings mapping to strings

modo.mprop.threading.warnings.linecache.os.execvp

type: function

doc: execvp(file, args) Execute the executable file (which is searched for along $PATH) with argument list args, replacing the current process. args may be a list or tuple of strings.

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.execvpe

type: function

doc: execvpe(file, args, env) Execute the executable file (which is searched for along $PATH) with argument list args and environment env , replacing the current process. args may be a list or tuple of strings.

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.extsep

type: str

modo.mprop.threading.warnings.linecache.os.F_OK

type: int

modo.mprop.threading.warnings.linecache.os.fdopen()

type: builtin_function_or_method

doc: fdopen(fd [, mode='r' [, bufsize]]) -> file_object Return an open file object connected to a file descriptor.

modo.mprop.threading.warnings.linecache.os.fstat()

type: builtin_function_or_method

doc: fstat(fd) -> stat result Like stat(), but for an open file descriptor.

modo.mprop.threading.warnings.linecache.os.fsync()

type: builtin_function_or_method

doc: fsync(fildes) force write of file with filedescriptor to disk.

modo.mprop.threading.warnings.linecache.os.getcwd()

type: builtin_function_or_method

doc: getcwd() -> path Return a string representing the current working directory.

modo.mprop.threading.warnings.linecache.os.getcwdu()

type: builtin_function_or_method

doc: getcwdu() -> path Return a unicode string representing the current working directory.

modo.mprop.threading.warnings.linecache.os.getenv

type: function

doc: Get an environment variable, return None if it doesn't exist. The optional second argument can specify an alternate default.

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.getpid()

type: builtin_function_or_method

doc: getpid() -> pid Return the current process id

modo.mprop.threading.warnings.linecache.os.isatty()

type: builtin_function_or_method

doc: isatty(fd) -> bool Return True if the file descriptor 'fd' is an open file descriptor connected to the slave end of a terminal.

modo.mprop.threading.warnings.linecache.os.kill()

type: builtin_function_or_method

doc: kill(pid, sig) Kill a process with a signal.

modo.mprop.threading.warnings.linecache.os.linesep

type: str

modo.mprop.threading.warnings.linecache.os.listdir()

type: builtin_function_or_method

doc: listdir(path) -> list_of_strings Return a list containing the names of the entries in the directory. path: path of directory to list The list is in arbitrary order. It does not include the special entries '.' and '..' even if they are present in the directory.

modo.mprop.threading.warnings.linecache.os.lseek()

type: builtin_function_or_method

doc: lseek(fd, pos, how) -> newpos Set the current position of a file descriptor.

modo.mprop.threading.warnings.linecache.os.lstat()

type: builtin_function_or_method

doc: lstat(path) -> stat result Like stat(path), but do not follow symbolic links.

modo.mprop.threading.warnings.linecache.os.makedirs

type: function

doc: makedirs(path [, mode=0777]) Super-mkdir; create a leaf directory and all intermediate ones. Works like mkdir, except that any intermediate path segment (not just the rightmost) will be created if it does not exist. This is recursive.

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.mkdir()

type: builtin_function_or_method

doc: mkdir(path [, mode=0777]) Create a directory.

modo.mprop.threading.warnings.linecache.os.name

type: str

modo.mprop.threading.warnings.linecache.os.O_APPEND

type: int

modo.mprop.threading.warnings.linecache.os.O_BINARY

type: int

modo.mprop.threading.warnings.linecache.os.O_CREAT

type: int

modo.mprop.threading.warnings.linecache.os.O_EXCL

type: int

modo.mprop.threading.warnings.linecache.os.O_NOINHERIT

type: int

modo.mprop.threading.warnings.linecache.os.O_RANDOM

type: int

modo.mprop.threading.warnings.linecache.os.O_RDONLY

type: int

modo.mprop.threading.warnings.linecache.os.O_RDWR

type: int

modo.mprop.threading.warnings.linecache.os.O_SEQUENTIAL

type: int

modo.mprop.threading.warnings.linecache.os.O_SHORT_LIVED

type: int

modo.mprop.threading.warnings.linecache.os.O_TEMPORARY

type: int

modo.mprop.threading.warnings.linecache.os.O_TEXT

type: int

modo.mprop.threading.warnings.linecache.os.O_TRUNC

type: int

modo.mprop.threading.warnings.linecache.os.O_WRONLY

type: int

modo.mprop.threading.warnings.linecache.os.open()

type: builtin_function_or_method

doc: open(filename, flag [, mode=0777]) -> fd Open a file (for low level IO).

modo.mprop.threading.warnings.linecache.os.P_DETACH

type: int

modo.mprop.threading.warnings.linecache.os.P_NOWAIT

type: int

modo.mprop.threading.warnings.linecache.os.P_NOWAITO

type: int

modo.mprop.threading.warnings.linecache.os.P_OVERLAY

type: int

modo.mprop.threading.warnings.linecache.os.P_WAIT

type: int

modo.mprop.threading.warnings.linecache.os.pardir

type: str

modo.mprop.threading.warnings.linecache.os.path

type: module

doc: Common pathname manipulations, WindowsNT/95 version. Instead of importing this module directly, import os and refer to this module as os.path.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\ntpath.pyc

modo.mprop.threading.warnings.linecache.os.pathsep

type: str

modo.mprop.threading.warnings.linecache.os.pipe()

type: builtin_function_or_method

doc: pipe() -> (read_end, write_end) Create a pipe.

modo.mprop.threading.warnings.linecache.os.popen()

type: builtin_function_or_method

doc: popen(command [, mode='r' [, bufsize]]) -> pipe Open a pipe to/from a command returning a file object.

modo.mprop.threading.warnings.linecache.os.popen2()

type: builtin_function_or_method

modo.mprop.threading.warnings.linecache.os.popen3()

type: builtin_function_or_method

modo.mprop.threading.warnings.linecache.os.popen4()

type: builtin_function_or_method

modo.mprop.threading.warnings.linecache.os.putenv()

type: builtin_function_or_method

doc: putenv(key, value) Change or add an environment variable.

modo.mprop.threading.warnings.linecache.os.R_OK

type: int

modo.mprop.threading.warnings.linecache.os.read()

type: builtin_function_or_method

doc: read(fd, buffersize) -> string Read a file descriptor.

modo.mprop.threading.warnings.linecache.os.remove()

type: builtin_function_or_method

doc: remove(path) Remove a file (same as unlink(path)).

modo.mprop.threading.warnings.linecache.os.removedirs

type: function

doc: removedirs(path) Super-rmdir; remove a leaf directory and all empty intermediate ones. Works like rmdir except that, if the leaf directory is successfully removed, directories corresponding to rightmost path segments will be pruned away until either the whole path is consumed or an error occurs. Errors during this latter phase are ignored -- they generally mean that a directory was not empty.

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.rename()

type: builtin_function_or_method

doc: rename(old, new) Rename a file or directory.

modo.mprop.threading.warnings.linecache.os.renames

type: function

doc: renames(old, new) Super-rename; create directories as necessary and delete any left empty. Works like rename, except creation of any intermediate directories needed to make the new pathname good is attempted first. After the rename, directories corresponding to rightmost path segments of the old name will be pruned way until either the whole path is consumed or a nonempty directory is found. Note: this function can fail with the new directory structure made if you lack permissions needed to unlink the leaf directory or file.

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.rmdir()

type: builtin_function_or_method

doc: rmdir(path) Remove a directory.

modo.mprop.threading.warnings.linecache.os.SEEK_CUR

type: int

modo.mprop.threading.warnings.linecache.os.SEEK_END

type: int

modo.mprop.threading.warnings.linecache.os.SEEK_SET

type: int

modo.mprop.threading.warnings.linecache.os.sep

type: str

modo.mprop.threading.warnings.linecache.os.spawnl

type: function

doc: spawnl(mode, file, *args) -> integer Execute file with arguments from args in a subprocess. If mode == P_NOWAIT return the pid of the process. If mode == P_WAIT return the process's exit code if it exits normally; otherwise return -SIG, where SIG is the signal that killed it.

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.spawnle

type: function

doc: spawnle(mode, file, *args, env) -> integer Execute file with arguments from args in a subprocess with the supplied environment. If mode == P_NOWAIT return the pid of the process. If mode == P_WAIT return the process's exit code if it exits normally; otherwise return -SIG, where SIG is the signal that killed it.

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.spawnv()

type: builtin_function_or_method

doc: spawnv(mode, path, args) Execute the program 'path' in a new process. mode: mode of process creation path: path of executable file args: tuple or list of strings

modo.mprop.threading.warnings.linecache.os.spawnve()

type: builtin_function_or_method

doc: spawnve(mode, path, args, env) Execute the program 'path' in a new process. mode: mode of process creation path: path of executable file args: tuple or list of arguments env: dictionary of strings mapping to strings

modo.mprop.threading.warnings.linecache.os.startfile()

type: builtin_function_or_method

doc: startfile(filepath [, operation]) - Start a file with its associated application. When "operation" is not specified or "open", this acts like double-clicking the file in Explorer, or giving the file name as an argument to the DOS "start" command: the file is opened with whatever application (if any) its extension is associated. When another "operation" is given, it specifies what should be done with the file. A typical operation is "print". startfile returns as soon as the associated application is launched. There is no option to wait for the application to close, and no way to retrieve the application's exit status. The filepath is relative to the current directory. If you want to use an absolute path, make sure the first character is not a slash ("/"); the underlying Win32 ShellExecute function doesn't work if it is.

modo.mprop.threading.warnings.linecache.os.stat()

type: builtin_function_or_method

doc: stat(path) -> stat result Perform a stat system call on the given path.

modo.mprop.threading.warnings.linecache.os.stat_float_times()

type: builtin_function_or_method

doc: stat_float_times([newval]) -> oldval Determine whether os.[lf]stat represents time stamps as float objects. If newval is True, future calls to stat() return floats, if it is False, future calls return ints. If newval is omitted, return the current setting.

modo.mprop.threading.warnings.linecache.os.stat_result

type: type

doc: stat_result: Result from stat or lstat. This object may be accessed either as a tuple of (mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime) or via the attributes st_mode, st_ino, st_dev, st_nlink, st_uid, and so on. Posix/windows: If your platform supports st_blksize, st_blocks, st_rdev, or st_flags, they are available as attributes only. See os.stat for more information.

modo.mprop.threading.warnings.linecache.os.statvfs_result

type: type

doc: statvfs_result: Result from statvfs or fstatvfs. This object may be accessed either as a tuple of (bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flag, namemax), or via the attributes f_bsize, f_frsize, f_blocks, f_bfree, and so on. See os.statvfs for more information.

modo.mprop.threading.warnings.linecache.os.strerror()

type: builtin_function_or_method

doc: strerror(code) -> string Translate an error code to a message string.

modo.mprop.threading.warnings.linecache.os.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.mprop.threading.warnings.linecache.os.system()

type: builtin_function_or_method

doc: system(command) -> exit_status Execute the command (a string) in a subshell.

modo.mprop.threading.warnings.linecache.os.tempnam()

type: builtin_function_or_method

doc: tempnam([dir[, prefix]]) -> string Return a unique name for a temporary file. The directory and a prefix may be specified as strings; they may be omitted or None if not needed.

modo.mprop.threading.warnings.linecache.os.times()

type: builtin_function_or_method

doc: times() -> (utime, stime, cutime, cstime, elapsed_time) Return a tuple of floating point numbers indicating process times.

modo.mprop.threading.warnings.linecache.os.TMP_MAX

type: int

modo.mprop.threading.warnings.linecache.os.tmpfile()

type: builtin_function_or_method

doc: tmpfile() -> file object Create a temporary file with no directory entries.

modo.mprop.threading.warnings.linecache.os.tmpnam()

type: builtin_function_or_method

doc: tmpnam() -> string Return a unique name for a temporary file.

modo.mprop.threading.warnings.linecache.os.umask()

type: builtin_function_or_method

doc: umask(new_mask) -> old_mask Set the current numeric umask and return the previous umask.

type: builtin_function_or_method

doc: unlink(path) Remove a file (same as remove(path)).

modo.mprop.threading.warnings.linecache.os.unsetenv

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.urandom()

type: builtin_function_or_method

doc: urandom(n) -> str Return n random bytes suitable for cryptographic use.

modo.mprop.threading.warnings.linecache.os.UserDict

type: module

doc: A more or less complete user-defined wrapper around dictionary objects.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\UserDict.pyc

modo.mprop.threading.warnings.linecache.os.utime()

type: builtin_function_or_method

doc: utime(path, (atime, mtime)) utime(path, None) Set the access and modified time of the file to the given values. If the second form is used, set the access and modified times to the current time.

modo.mprop.threading.warnings.linecache.os.W_OK

type: int

modo.mprop.threading.warnings.linecache.os.waitpid()

type: builtin_function_or_method

doc: waitpid(pid, options) -> (pid, status << 8) Wait for completion of a given process. options is ignored on Windows.

modo.mprop.threading.warnings.linecache.os.walk

type: function

doc: Directory tree generator. For each directory in the directory tree rooted at top (including top itself, but excluding '.' and '..'), yields a 3-tuple dirpath, dirnames, filenames dirpath is a string, the path to the directory. dirnames is a list of the names of the subdirectories in dirpath (excluding '.' and '..'). filenames is a list of the names of the non-directory files in dirpath. Note that the names in the lists are just names, with no path components. To get a full path (which begins with top) to a file or directory in dirpath, do os.path.join(dirpath, name). If optional arg 'topdown' is true or not specified, the triple for a directory is generated before the triples for any of its subdirectories (directories are generated top down). If topdown is false, the triple for a directory is generated after the triples for all of its subdirectories (directories are generated bottom up). When topdown is true, the caller can modify the dirnames list in-place (e.g., via del or slice assignment), and walk will only recurse into the subdirectories whose names remain in dirnames; this can be used to prune the search, or to impose a specific order of visiting. Modifying dirnames when topdown is false is ineffective, since the directories in dirnames have already been generated by the time dirnames itself is generated. By default errors from the os.listdir() call are ignored. If optional arg 'onerror' is specified, it should be a function; it will be called with one argument, an os.error instance. It can report the error to continue with the walk, or raise the exception to abort the walk. Note that the filename is available as the filename attribute of the exception object. By default, os.walk does not follow symbolic links to subdirectories on systems that support them. In order to get this functionality, set the optional argument 'followlinks' to true. Caution: if you pass a relative pathname for top, don't change the current working directory between resumptions of walk. walk never changes the current directory, and assumes that the client doesn't either. Example: import os from os.path import join, getsize for root, dirs, files in os.walk('python/Lib/email'): print root, "consumes", print sum([getsize(join(root, name)) for name in files]), print "bytes in", len(files), "non-directory files" if 'CVS' in dirs: dirs.remove('CVS') # don't visit CVS directories

file: u:\Luxology\source\extra\python\python2.7\lib\os.py

modo.mprop.threading.warnings.linecache.os.write()

type: builtin_function_or_method

doc: write(fd, string) -> byteswritten Write a string to a file descriptor.

modo.mprop.threading.warnings.linecache.os.X_OK

type: int
modo.mprop.threading.warnings.linecache.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.mprop.threading.warnings.linecache.sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.mprop.threading.warnings.linecache.sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.mprop.threading.warnings.linecache.sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.mprop.threading.warnings.linecache.sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.threading.warnings.linecache.sys.api_version

type: int

modo.mprop.threading.warnings.linecache.sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.threading.warnings.linecache.sys.byteorder

type: str

modo.mprop.threading.warnings.linecache.sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.mprop.threading.warnings.linecache.sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.mprop.threading.warnings.linecache.sys.copyright

type: str

modo.mprop.threading.warnings.linecache.sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.mprop.threading.warnings.linecache.sys.dllhandle

type: long

modo.mprop.threading.warnings.linecache.sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.threading.warnings.linecache.sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.mprop.threading.warnings.linecache.sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.mprop.threading.warnings.linecache.sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.mprop.threading.warnings.linecache.sys.exc_type

type: type

doc: Inappropriate argument type.

modo.mprop.threading.warnings.linecache.sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.mprop.threading.warnings.linecache.sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.mprop.threading.warnings.linecache.sys.exec_prefix

type: str

modo.mprop.threading.warnings.linecache.sys.executable

type: str

modo.mprop.threading.warnings.linecache.sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.mprop.threading.warnings.linecache.sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.mprop.threading.warnings.linecache.sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.mprop.threading.warnings.linecache.sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.mprop.threading.warnings.linecache.sys.float_repr_style

type: str

modo.mprop.threading.warnings.linecache.sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.mprop.threading.warnings.linecache.sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.mprop.threading.warnings.linecache.sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.mprop.threading.warnings.linecache.sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.mprop.threading.warnings.linecache.sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.mprop.threading.warnings.linecache.sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.mprop.threading.warnings.linecache.sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.mprop.threading.warnings.linecache.sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.mprop.threading.warnings.linecache.sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.mprop.threading.warnings.linecache.sys.hexversion

type: int

modo.mprop.threading.warnings.linecache.sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.mprop.threading.warnings.linecache.sys.maxint

type: int

modo.mprop.threading.warnings.linecache.sys.maxsize

type: long

modo.mprop.threading.warnings.linecache.sys.maxunicode

type: int

modo.mprop.threading.warnings.linecache.sys.meta_path

type: list

modo.mprop.threading.warnings.linecache.sys.modules

type: dict

modo.mprop.threading.warnings.linecache.sys.path

type: list

modo.mprop.threading.warnings.linecache.sys.path_hooks

type: list

modo.mprop.threading.warnings.linecache.sys.path_importer_cache

type: dict

modo.mprop.threading.warnings.linecache.sys.platform

type: str

modo.mprop.threading.warnings.linecache.sys.prefix

type: str

modo.mprop.threading.warnings.linecache.sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.threading.warnings.linecache.sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.mprop.threading.warnings.linecache.sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.mprop.threading.warnings.linecache.sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.mprop.threading.warnings.linecache.sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.mprop.threading.warnings.linecache.sys.stderr

type: SESysStdErr

modo.mprop.threading.warnings.linecache.sys.stdin

type: SESysStdIn

modo.mprop.threading.warnings.linecache.sys.stdout

type: SESysStdOut

modo.mprop.threading.warnings.linecache.sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.threading.warnings.linecache.sys.version

type: str

modo.mprop.threading.warnings.linecache.sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.mprop.threading.warnings.linecache.sys.warnoptions

type: list

modo.mprop.threading.warnings.linecache.sys.winver

type: str

modo.mprop.threading.warnings.linecache.updatecache

type: function

doc: Update a cache entry and return its list of lines. If something's wrong, print a message, discard the cache entry, and return an empty list.

file: u:\Luxology\source\extra\python\python2.7\lib\linecache.py

modo.mprop.threading.warnings.once_registry type: dict

modo.mprop.threading.warnings.once_registry.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mprop.threading.warnings.once_registry.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mprop.threading.warnings.once_registry.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.threading.warnings.once_registry.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.threading.warnings.once_registry.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.threading.warnings.once_registry.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.threading.warnings.once_registry.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.threading.warnings.once_registry.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.threading.warnings.once_registry.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.threading.warnings.once_registry.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mprop.threading.warnings.once_registry.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.threading.warnings.once_registry.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.threading.warnings.once_registry.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.threading.warnings.once_registry.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.threading.warnings.once_registry.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mprop.threading.warnings.once_registry.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.threading.warnings.once_registry.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.threading.warnings.once_registry.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.threading.warnings.onceregistry type: dict

modo.mprop.threading.warnings.onceregistry.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mprop.threading.warnings.onceregistry.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mprop.threading.warnings.onceregistry.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.threading.warnings.onceregistry.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.threading.warnings.onceregistry.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.threading.warnings.onceregistry.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.threading.warnings.onceregistry.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.threading.warnings.onceregistry.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.threading.warnings.onceregistry.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.threading.warnings.onceregistry.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mprop.threading.warnings.onceregistry.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.threading.warnings.onceregistry.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.threading.warnings.onceregistry.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.threading.warnings.onceregistry.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.threading.warnings.onceregistry.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mprop.threading.warnings.onceregistry.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.threading.warnings.onceregistry.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.threading.warnings.onceregistry.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.threading.warnings.resetwarnings

type: function

doc: Clear the list of warning filters, so that no filters are active.

file: u:\Luxology\source\extra\python\python2.7\lib\warnings.py

modo.mprop.threading.warnings.showwarning

type: function

doc: Hook to write a warning to a file; replace if you like.

file: u:\Luxology\source\extra\python\python2.7\lib\warnings.py

modo.mprop.threading.warnings.simplefilter

type: function

doc: Insert a simple entry into the list of warnings filters (at the front). A simple filter matches all modules and messages. 'action' -- one of "error", "ignore", "always", "default", "module", or "once" 'category' -- a class that the warning must be a subclass of 'lineno' -- an integer line number, 0 matches all warnings 'append' -- if true, append to the list of filters

file: u:\Luxology\source\extra\python\python2.7\lib\warnings.py

modo.mprop.threading.warnings.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.mprop.threading.warnings.sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.mprop.threading.warnings.sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.mprop.threading.warnings.sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.mprop.threading.warnings.sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.threading.warnings.sys.api_version

type: int

modo.mprop.threading.warnings.sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.threading.warnings.sys.byteorder

type: str

modo.mprop.threading.warnings.sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.mprop.threading.warnings.sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.mprop.threading.warnings.sys.copyright

type: str

modo.mprop.threading.warnings.sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.mprop.threading.warnings.sys.dllhandle

type: long

modo.mprop.threading.warnings.sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.threading.warnings.sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.mprop.threading.warnings.sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.mprop.threading.warnings.sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.mprop.threading.warnings.sys.exc_type

type: type

doc: Inappropriate argument type.

    modo.mprop.threading.warnings.sys.exc_type contents:
  • modo.mprop.threading.warnings.sys.exc_type.__class__
  • modo.mprop.threading.warnings.sys.exc_type.__delattr__
  • modo.mprop.threading.warnings.sys.exc_type.__dict__
  • modo.mprop.threading.warnings.sys.exc_type.__doc__
  • modo.mprop.threading.warnings.sys.exc_type.__format__
  • modo.mprop.threading.warnings.sys.exc_type.__getattribute__
  • modo.mprop.threading.warnings.sys.exc_type.__getitem__
  • modo.mprop.threading.warnings.sys.exc_type.__getslice__
  • modo.mprop.threading.warnings.sys.exc_type.__hash__
  • modo.mprop.threading.warnings.sys.exc_type.__init__
  • modo.mprop.threading.warnings.sys.exc_type.__new__
  • modo.mprop.threading.warnings.sys.exc_type.__reduce__
  • modo.mprop.threading.warnings.sys.exc_type.__reduce_ex__
  • modo.mprop.threading.warnings.sys.exc_type.__repr__
  • modo.mprop.threading.warnings.sys.exc_type.__setattr__
  • modo.mprop.threading.warnings.sys.exc_type.__setstate__
  • modo.mprop.threading.warnings.sys.exc_type.__sizeof__
  • modo.mprop.threading.warnings.sys.exc_type.__str__
  • modo.mprop.threading.warnings.sys.exc_type.__subclasshook__
  • modo.mprop.threading.warnings.sys.exc_type.__unicode__
  • modo.mprop.threading.warnings.sys.exc_type.args
  • modo.mprop.threading.warnings.sys.exc_type.message

modo.mprop.threading.warnings.sys.exc_type.args

type: getset_descriptor

modo.mprop.threading.warnings.sys.exc_type.message

type: getset_descriptor

modo.mprop.threading.warnings.sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.mprop.threading.warnings.sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.mprop.threading.warnings.sys.exec_prefix

type: str

modo.mprop.threading.warnings.sys.executable

type: str

modo.mprop.threading.warnings.sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.mprop.threading.warnings.sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.mprop.threading.warnings.sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.mprop.threading.warnings.sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.mprop.threading.warnings.sys.float_repr_style

type: str

modo.mprop.threading.warnings.sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.mprop.threading.warnings.sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.mprop.threading.warnings.sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.mprop.threading.warnings.sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.mprop.threading.warnings.sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.mprop.threading.warnings.sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.mprop.threading.warnings.sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.mprop.threading.warnings.sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.mprop.threading.warnings.sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.mprop.threading.warnings.sys.hexversion

type: int

modo.mprop.threading.warnings.sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.mprop.threading.warnings.sys.maxint

type: int

modo.mprop.threading.warnings.sys.maxsize

type: long

modo.mprop.threading.warnings.sys.maxunicode

type: int

modo.mprop.threading.warnings.sys.meta_path

type: list
modo.mprop.threading.warnings.sys.modules type: dict

modo.mprop.threading.warnings.sys.modules.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mprop.threading.warnings.sys.modules.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mprop.threading.warnings.sys.modules.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.threading.warnings.sys.modules.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.threading.warnings.sys.modules.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.threading.warnings.sys.modules.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.threading.warnings.sys.modules.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.threading.warnings.sys.modules.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.threading.warnings.sys.modules.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.threading.warnings.sys.modules.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mprop.threading.warnings.sys.modules.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.threading.warnings.sys.modules.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.threading.warnings.sys.modules.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.threading.warnings.sys.modules.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.threading.warnings.sys.modules.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mprop.threading.warnings.sys.modules.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.threading.warnings.sys.modules.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.threading.warnings.sys.modules.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.threading.warnings.sys.path

type: list

modo.mprop.threading.warnings.sys.path_hooks

type: list
modo.mprop.threading.warnings.sys.path_importer_cache type: dict

modo.mprop.threading.warnings.sys.path_importer_cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.mprop.threading.warnings.sys.path_importer_cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.mprop.threading.warnings.sys.path_importer_cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.threading.warnings.sys.path_importer_cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.threading.warnings.sys.path_importer_cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.threading.warnings.sys.path_importer_cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.threading.warnings.sys.path_importer_cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.threading.warnings.sys.path_importer_cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.threading.warnings.sys.path_importer_cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.threading.warnings.sys.path_importer_cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.mprop.threading.warnings.sys.path_importer_cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.threading.warnings.sys.path_importer_cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.threading.warnings.sys.path_importer_cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.threading.warnings.sys.path_importer_cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.threading.warnings.sys.path_importer_cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.mprop.threading.warnings.sys.path_importer_cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.threading.warnings.sys.path_importer_cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.threading.warnings.sys.path_importer_cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.threading.warnings.sys.platform

type: str

modo.mprop.threading.warnings.sys.prefix

type: str

modo.mprop.threading.warnings.sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.mprop.threading.warnings.sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.mprop.threading.warnings.sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.mprop.threading.warnings.sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.mprop.threading.warnings.sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.mprop.threading.warnings.sys.stderr

type: SESysStdErr

modo.mprop.threading.warnings.sys.stdin

type: SESysStdIn

modo.mprop.threading.warnings.sys.stdout

type: SESysStdOut

modo.mprop.threading.warnings.sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.threading.warnings.sys.version

type: str

modo.mprop.threading.warnings.sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.mprop.threading.warnings.sys.warnoptions

type: list

modo.mprop.threading.warnings.sys.winver

type: str
modo.mprop.threading.warnings.types

type: module

doc: Define names for all type symbols known in the standard interpreter. Types that are part of optional modules (e.g. array) are not listed.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\types.pyc

modo.mprop.threading.warnings.types.BooleanType

type: type

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    modo.mprop.threading.warnings.types.BooleanType contents:
  • modo.mprop.threading.warnings.types.BooleanType.__abs__
  • modo.mprop.threading.warnings.types.BooleanType.__add__
  • modo.mprop.threading.warnings.types.BooleanType.__and__
  • modo.mprop.threading.warnings.types.BooleanType.__class__
  • modo.mprop.threading.warnings.types.BooleanType.__cmp__
  • modo.mprop.threading.warnings.types.BooleanType.__coerce__
  • modo.mprop.threading.warnings.types.BooleanType.__delattr__
  • modo.mprop.threading.warnings.types.BooleanType.__div__
  • modo.mprop.threading.warnings.types.BooleanType.__divmod__
  • modo.mprop.threading.warnings.types.BooleanType.__doc__
  • modo.mprop.threading.warnings.types.BooleanType.__float__
  • modo.mprop.threading.warnings.types.BooleanType.__floordiv__
  • modo.mprop.threading.warnings.types.BooleanType.__format__
  • modo.mprop.threading.warnings.types.BooleanType.__getattribute__
  • modo.mprop.threading.warnings.types.BooleanType.__getnewargs__
  • modo.mprop.threading.warnings.types.BooleanType.__hash__
  • modo.mprop.threading.warnings.types.BooleanType.__hex__
  • modo.mprop.threading.warnings.types.BooleanType.__index__
  • modo.mprop.threading.warnings.types.BooleanType.__init__
  • modo.mprop.threading.warnings.types.BooleanType.__int__
  • modo.mprop.threading.warnings.types.BooleanType.__invert__
  • modo.mprop.threading.warnings.types.BooleanType.__long__
  • modo.mprop.threading.warnings.types.BooleanType.__lshift__
  • modo.mprop.threading.warnings.types.BooleanType.__mod__
  • modo.mprop.threading.warnings.types.BooleanType.__mul__
  • modo.mprop.threading.warnings.types.BooleanType.__neg__
  • modo.mprop.threading.warnings.types.BooleanType.__new__
  • modo.mprop.threading.warnings.types.BooleanType.__nonzero__
  • modo.mprop.threading.warnings.types.BooleanType.__oct__
  • modo.mprop.threading.warnings.types.BooleanType.__or__
  • modo.mprop.threading.warnings.types.BooleanType.__pos__
  • modo.mprop.threading.warnings.types.BooleanType.__pow__
  • modo.mprop.threading.warnings.types.BooleanType.__radd__
  • modo.mprop.threading.warnings.types.BooleanType.__rand__
  • modo.mprop.threading.warnings.types.BooleanType.__rdiv__
  • modo.mprop.threading.warnings.types.BooleanType.__rdivmod__
  • modo.mprop.threading.warnings.types.BooleanType.__reduce__
  • modo.mprop.threading.warnings.types.BooleanType.__reduce_ex__
  • modo.mprop.threading.warnings.types.BooleanType.__repr__
  • modo.mprop.threading.warnings.types.BooleanType.__rfloordiv__
  • modo.mprop.threading.warnings.types.BooleanType.__rlshift__
  • modo.mprop.threading.warnings.types.BooleanType.__rmod__
  • modo.mprop.threading.warnings.types.BooleanType.__rmul__
  • modo.mprop.threading.warnings.types.BooleanType.__ror__
  • modo.mprop.threading.warnings.types.BooleanType.__rpow__
  • modo.mprop.threading.warnings.types.BooleanType.__rrshift__
  • modo.mprop.threading.warnings.types.BooleanType.__rshift__
  • modo.mprop.threading.warnings.types.BooleanType.__rsub__
  • modo.mprop.threading.warnings.types.BooleanType.__rtruediv__
  • modo.mprop.threading.warnings.types.BooleanType.__rxor__
  • modo.mprop.threading.warnings.types.BooleanType.__setattr__
  • modo.mprop.threading.warnings.types.BooleanType.__sizeof__
  • modo.mprop.threading.warnings.types.BooleanType.__str__
  • modo.mprop.threading.warnings.types.BooleanType.__sub__
  • modo.mprop.threading.warnings.types.BooleanType.__subclasshook__
  • modo.mprop.threading.warnings.types.BooleanType.__truediv__
  • modo.mprop.threading.warnings.types.BooleanType.__trunc__
  • modo.mprop.threading.warnings.types.BooleanType.__xor__
  • modo.mprop.threading.warnings.types.BooleanType.bit_length
  • modo.mprop.threading.warnings.types.BooleanType.conjugate
  • modo.mprop.threading.warnings.types.BooleanType.denominator
  • modo.mprop.threading.warnings.types.BooleanType.imag
  • modo.mprop.threading.warnings.types.BooleanType.numerator
  • modo.mprop.threading.warnings.types.BooleanType.real

modo.mprop.threading.warnings.types.BooleanType.bit_length()

type: method_descriptor

doc: int.bit_length() -> int Number of bits necessary to represent self in binary. >>> bin(37) '0b100101' >>> (37).bit_length() 6

modo.mprop.threading.warnings.types.BooleanType.conjugate()

type: method_descriptor

doc: Returns self, the complex conjugate of any int.

modo.mprop.threading.warnings.types.BooleanType.denominator

type: getset_descriptor

doc: the denominator of a rational number in lowest terms

modo.mprop.threading.warnings.types.BooleanType.imag

type: getset_descriptor

doc: the imaginary part of a complex number

modo.mprop.threading.warnings.types.BooleanType.numerator

type: getset_descriptor

doc: the numerator of a rational number in lowest terms

modo.mprop.threading.warnings.types.BooleanType.real

type: getset_descriptor

doc: the real part of a complex number

modo.mprop.threading.warnings.types.BufferType

type: type

doc: buffer(object [, offset[, size]]) Create a new buffer object which references the given object. The buffer will reference a slice of the target object from the start of the object (or at the specified offset). The slice will extend to the end of the target object (or with the specified size).

    modo.mprop.threading.warnings.types.BufferType contents:
  • modo.mprop.threading.warnings.types.BufferType.__add__
  • modo.mprop.threading.warnings.types.BufferType.__class__
  • modo.mprop.threading.warnings.types.BufferType.__cmp__
  • modo.mprop.threading.warnings.types.BufferType.__delattr__
  • modo.mprop.threading.warnings.types.BufferType.__delitem__
  • modo.mprop.threading.warnings.types.BufferType.__delslice__
  • modo.mprop.threading.warnings.types.BufferType.__doc__
  • modo.mprop.threading.warnings.types.BufferType.__format__
  • modo.mprop.threading.warnings.types.BufferType.__getattribute__
  • modo.mprop.threading.warnings.types.BufferType.__getitem__
  • modo.mprop.threading.warnings.types.BufferType.__getslice__
  • modo.mprop.threading.warnings.types.BufferType.__hash__
  • modo.mprop.threading.warnings.types.BufferType.__init__
  • modo.mprop.threading.warnings.types.BufferType.__len__
  • modo.mprop.threading.warnings.types.BufferType.__mul__
  • modo.mprop.threading.warnings.types.BufferType.__new__
  • modo.mprop.threading.warnings.types.BufferType.__reduce__
  • modo.mprop.threading.warnings.types.BufferType.__reduce_ex__
  • modo.mprop.threading.warnings.types.BufferType.__repr__
  • modo.mprop.threading.warnings.types.BufferType.__rmul__
  • modo.mprop.threading.warnings.types.BufferType.__setattr__
  • modo.mprop.threading.warnings.types.BufferType.__setitem__
  • modo.mprop.threading.warnings.types.BufferType.__setslice__
  • modo.mprop.threading.warnings.types.BufferType.__sizeof__
  • modo.mprop.threading.warnings.types.BufferType.__str__
  • modo.mprop.threading.warnings.types.BufferType.__subclasshook__
modo.mprop.threading.warnings.types.BuiltinFunctionType

type: type

    modo.mprop.threading.warnings.types.BuiltinFunctionType contents:
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__call__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__class__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__cmp__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__delattr__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__doc__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__eq__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__format__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__ge__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__getattribute__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__gt__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__hash__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__init__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__le__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__lt__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__module__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__name__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__ne__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__new__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__reduce__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__reduce_ex__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__repr__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__self__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__setattr__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__sizeof__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__str__
  • modo.mprop.threading.warnings.types.BuiltinFunctionType.__subclasshook__
modo.mprop.threading.warnings.types.BuiltinMethodType

type: type

    modo.mprop.threading.warnings.types.BuiltinMethodType contents:
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__call__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__class__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__cmp__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__delattr__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__doc__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__eq__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__format__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__ge__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__getattribute__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__gt__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__hash__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__init__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__le__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__lt__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__module__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__name__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__ne__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__new__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__reduce__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__reduce_ex__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__repr__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__self__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__setattr__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__sizeof__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__str__
  • modo.mprop.threading.warnings.types.BuiltinMethodType.__subclasshook__
modo.mprop.threading.warnings.types.ClassType

type: type

doc: classobj(name, bases, dict) Create a class object. The name must be a string; the second argument a tuple of classes, and the third a dictionary.

    modo.mprop.threading.warnings.types.ClassType contents:
  • modo.mprop.threading.warnings.types.ClassType.__call__
  • modo.mprop.threading.warnings.types.ClassType.__class__
  • modo.mprop.threading.warnings.types.ClassType.__delattr__
  • modo.mprop.threading.warnings.types.ClassType.__doc__
  • modo.mprop.threading.warnings.types.ClassType.__format__
  • modo.mprop.threading.warnings.types.ClassType.__getattribute__
  • modo.mprop.threading.warnings.types.ClassType.__hash__
  • modo.mprop.threading.warnings.types.ClassType.__init__
  • modo.mprop.threading.warnings.types.ClassType.__new__
  • modo.mprop.threading.warnings.types.ClassType.__reduce__
  • modo.mprop.threading.warnings.types.ClassType.__reduce_ex__
  • modo.mprop.threading.warnings.types.ClassType.__repr__
  • modo.mprop.threading.warnings.types.ClassType.__setattr__
  • modo.mprop.threading.warnings.types.ClassType.__sizeof__
  • modo.mprop.threading.warnings.types.ClassType.__str__
  • modo.mprop.threading.warnings.types.ClassType.__subclasshook__
modo.mprop.threading.warnings.types.CodeType

type: type

doc: code(argcount, nlocals, stacksize, flags, codestring, constants, names, varnames, filename, name, firstlineno, lnotab[, freevars[, cellvars]]) Create a code object. Not for the faint of heart.

modo.mprop.threading.warnings.types.CodeType.co_argcount

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_cellvars

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_code

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_consts

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_filename

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_firstlineno

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_flags

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_freevars

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_lnotab

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_name

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_names

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_nlocals

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_stacksize

type: member_descriptor

modo.mprop.threading.warnings.types.CodeType.co_varnames

type: member_descriptor

modo.mprop.threading.warnings.types.ComplexType

type: type

doc: complex(real[, imag]) -> complex number Create a complex number from a real part and an optional imaginary part. This is equivalent to (real + imag*1j) where imag defaults to 0.

    modo.mprop.threading.warnings.types.ComplexType contents:
  • modo.mprop.threading.warnings.types.ComplexType.__abs__
  • modo.mprop.threading.warnings.types.ComplexType.__add__
  • modo.mprop.threading.warnings.types.ComplexType.__class__
  • modo.mprop.threading.warnings.types.ComplexType.__coerce__
  • modo.mprop.threading.warnings.types.ComplexType.__delattr__
  • modo.mprop.threading.warnings.types.ComplexType.__div__
  • modo.mprop.threading.warnings.types.ComplexType.__divmod__
  • modo.mprop.threading.warnings.types.ComplexType.__doc__
  • modo.mprop.threading.warnings.types.ComplexType.__eq__
  • modo.mprop.threading.warnings.types.ComplexType.__float__
  • modo.mprop.threading.warnings.types.ComplexType.__floordiv__
  • modo.mprop.threading.warnings.types.ComplexType.__format__
  • modo.mprop.threading.warnings.types.ComplexType.__ge__
  • modo.mprop.threading.warnings.types.ComplexType.__getattribute__
  • modo.mprop.threading.warnings.types.ComplexType.__getnewargs__
  • modo.mprop.threading.warnings.types.ComplexType.__gt__
  • modo.mprop.threading.warnings.types.ComplexType.__hash__
  • modo.mprop.threading.warnings.types.ComplexType.__init__
  • modo.mprop.threading.warnings.types.ComplexType.__int__
  • modo.mprop.threading.warnings.types.ComplexType.__le__
  • modo.mprop.threading.warnings.types.ComplexType.__long__
  • modo.mprop.threading.warnings.types.ComplexType.__lt__
  • modo.mprop.threading.warnings.types.ComplexType.__mod__
  • modo.mprop.threading.warnings.types.ComplexType.__mul__
  • modo.mprop.threading.warnings.types.ComplexType.__ne__
  • modo.mprop.threading.warnings.types.ComplexType.__neg__
  • modo.mprop.threading.warnings.types.ComplexType.__new__
  • modo.mprop.threading.warnings.types.ComplexType.__nonzero__
  • modo.mprop.threading.warnings.types.ComplexType.__pos__
  • modo.mprop.threading.warnings.types.ComplexType.__pow__
  • modo.mprop.threading.warnings.types.ComplexType.__radd__
  • modo.mprop.threading.warnings.types.ComplexType.__rdiv__
  • modo.mprop.threading.warnings.types.ComplexType.__rdivmod__
  • modo.mprop.threading.warnings.types.ComplexType.__reduce__
  • modo.mprop.threading.warnings.types.ComplexType.__reduce_ex__
  • modo.mprop.threading.warnings.types.ComplexType.__repr__
  • modo.mprop.threading.warnings.types.ComplexType.__rfloordiv__
  • modo.mprop.threading.warnings.types.ComplexType.__rmod__
  • modo.mprop.threading.warnings.types.ComplexType.__rmul__
  • modo.mprop.threading.warnings.types.ComplexType.__rpow__
  • modo.mprop.threading.warnings.types.ComplexType.__rsub__
  • modo.mprop.threading.warnings.types.ComplexType.__rtruediv__
  • modo.mprop.threading.warnings.types.ComplexType.__setattr__
  • modo.mprop.threading.warnings.types.ComplexType.__sizeof__
  • modo.mprop.threading.warnings.types.ComplexType.__str__
  • modo.mprop.threading.warnings.types.ComplexType.__sub__
  • modo.mprop.threading.warnings.types.ComplexType.__subclasshook__
  • modo.mprop.threading.warnings.types.ComplexType.__truediv__
  • modo.mprop.threading.warnings.types.ComplexType.conjugate
  • modo.mprop.threading.warnings.types.ComplexType.imag
  • modo.mprop.threading.warnings.types.ComplexType.real

modo.mprop.threading.warnings.types.ComplexType.conjugate()

type: method_descriptor

doc: complex.conjugate() -> complex Returns the complex conjugate of its argument. (3-4j).conjugate() == 3+4j.

modo.mprop.threading.warnings.types.ComplexType.imag

type: member_descriptor

doc: the imaginary part of a complex number

modo.mprop.threading.warnings.types.ComplexType.real

type: member_descriptor

doc: the real part of a complex number

modo.mprop.threading.warnings.types.DictionaryType

type: type

doc: dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

modo.mprop.threading.warnings.types.DictionaryType.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.mprop.threading.warnings.types.DictionaryType.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D

modo.mprop.threading.warnings.types.DictionaryType.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.threading.warnings.types.DictionaryType.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.threading.warnings.types.DictionaryType.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.threading.warnings.types.DictionaryType.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.threading.warnings.types.DictionaryType.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.threading.warnings.types.DictionaryType.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.threading.warnings.types.DictionaryType.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.threading.warnings.types.DictionaryType.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.mprop.threading.warnings.types.DictionaryType.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.threading.warnings.types.DictionaryType.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.threading.warnings.types.DictionaryType.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.threading.warnings.types.DictionaryType.update()

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.threading.warnings.types.DictionaryType.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.mprop.threading.warnings.types.DictionaryType.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.threading.warnings.types.DictionaryType.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.threading.warnings.types.DictionaryType.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.threading.warnings.types.DictProxyType

type: type

modo.mprop.threading.warnings.types.DictProxyType.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D

modo.mprop.threading.warnings.types.DictProxyType.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if D.has_key(k), else d. d defaults to None.

modo.mprop.threading.warnings.types.DictProxyType.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.threading.warnings.types.DictProxyType.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.threading.warnings.types.DictProxyType.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.threading.warnings.types.DictProxyType.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.threading.warnings.types.DictProxyType.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.threading.warnings.types.DictProxyType.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.mprop.threading.warnings.types.DictProxyType.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.mprop.threading.warnings.types.DictType

type: type

doc: dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

modo.mprop.threading.warnings.types.DictType.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.mprop.threading.warnings.types.DictType.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D

modo.mprop.threading.warnings.types.DictType.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.threading.warnings.types.DictType.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.threading.warnings.types.DictType.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.threading.warnings.types.DictType.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.threading.warnings.types.DictType.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.threading.warnings.types.DictType.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.threading.warnings.types.DictType.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.threading.warnings.types.DictType.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.mprop.threading.warnings.types.DictType.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.threading.warnings.types.DictType.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.threading.warnings.types.DictType.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.threading.warnings.types.DictType.update()

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.threading.warnings.types.DictType.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.mprop.threading.warnings.types.DictType.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.threading.warnings.types.DictType.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.threading.warnings.types.DictType.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.threading.warnings.types.EllipsisType

type: type

    modo.mprop.threading.warnings.types.EllipsisType contents:
  • modo.mprop.threading.warnings.types.EllipsisType.__class__
  • modo.mprop.threading.warnings.types.EllipsisType.__delattr__
  • modo.mprop.threading.warnings.types.EllipsisType.__doc__
  • modo.mprop.threading.warnings.types.EllipsisType.__format__
  • modo.mprop.threading.warnings.types.EllipsisType.__getattribute__
  • modo.mprop.threading.warnings.types.EllipsisType.__hash__
  • modo.mprop.threading.warnings.types.EllipsisType.__init__
  • modo.mprop.threading.warnings.types.EllipsisType.__new__
  • modo.mprop.threading.warnings.types.EllipsisType.__reduce__
  • modo.mprop.threading.warnings.types.EllipsisType.__reduce_ex__
  • modo.mprop.threading.warnings.types.EllipsisType.__repr__
  • modo.mprop.threading.warnings.types.EllipsisType.__setattr__
  • modo.mprop.threading.warnings.types.EllipsisType.__sizeof__
  • modo.mprop.threading.warnings.types.EllipsisType.__str__
  • modo.mprop.threading.warnings.types.EllipsisType.__subclasshook__
modo.mprop.threading.warnings.types.FileType

type: type

doc: file(name[, mode[, buffering]]) -> file object Open a file. The mode can be 'r', 'w' or 'a' for reading (default), writing or appending. The file will be created if it doesn't exist when opened for writing or appending; it will be truncated when opened for writing. Add a 'b' to the mode for binary files. Add a '+' to the mode to allow simultaneous reading and writing. If the buffering argument is given, 0 means unbuffered, 1 means line buffered, and larger numbers specify the buffer size. The preferred way to open a file is with the builtin open() function. Add a 'U' to mode to open the file for input with universal newline support. Any line ending in the input file will be seen as a '\n' in Python. Also, a file so opened gains the attribute 'newlines'; the value for this attribute is one of None (no newline read yet), '\r', '\n', '\r\n' or a tuple containing all the newline types seen. 'U' cannot be combined with 'w' or '+' mode.

modo.mprop.threading.warnings.types.FileType.close()

type: method_descriptor

doc: close() -> None or (perhaps) an integer. Close the file. Sets data attribute .closed to True. A closed file cannot be used for further I/O operations. close() may be called more than once without error. Some kinds of file objects (for example, opened by popen()) may return an exit status upon closing.

modo.mprop.threading.warnings.types.FileType.closed

type: getset_descriptor

doc: True if the file is closed

modo.mprop.threading.warnings.types.FileType.encoding

type: member_descriptor

doc: file encoding

modo.mprop.threading.warnings.types.FileType.errors

type: member_descriptor

doc: Unicode error handler

modo.mprop.threading.warnings.types.FileType.fileno()

type: method_descriptor

doc: fileno() -> integer "file descriptor". This is needed for lower-level file interfaces, such os.read().

modo.mprop.threading.warnings.types.FileType.flush()

type: method_descriptor

doc: flush() -> None. Flush the internal I/O buffer.

modo.mprop.threading.warnings.types.FileType.isatty()

type: method_descriptor

doc: isatty() -> true or false. True if the file is connected to a tty device.

modo.mprop.threading.warnings.types.FileType.mode

type: member_descriptor

doc: file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)

modo.mprop.threading.warnings.types.FileType.name

type: member_descriptor

doc: file name

modo.mprop.threading.warnings.types.FileType.newlines

type: getset_descriptor

doc: end-of-line convention used in this file

modo.mprop.threading.warnings.types.FileType.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.mprop.threading.warnings.types.FileType.read()

type: method_descriptor

doc: read([size]) -> read at most size bytes, returned as a string. If the size argument is negative or omitted, read until EOF is reached. Notice that when in non-blocking mode, less data than what was requested may be returned, even if no size parameter was given.

modo.mprop.threading.warnings.types.FileType.readinto()

type: method_descriptor

doc: readinto() -> Undocumented. Don't use this; it may go away.

modo.mprop.threading.warnings.types.FileType.readline()

type: method_descriptor

doc: readline([size]) -> next line from the file, as a string. Retain newline. A non-negative size argument limits the maximum number of bytes to return (an incomplete line may be returned then). Return an empty string at EOF.

modo.mprop.threading.warnings.types.FileType.readlines()

type: method_descriptor

doc: readlines([size]) -> list of strings, each a line from the file. Call readline() repeatedly and return a list of the lines so read. The optional size argument, if given, is an approximate bound on the total number of bytes in the lines returned.

modo.mprop.threading.warnings.types.FileType.seek()

type: method_descriptor

doc: seek(offset[, whence]) -> None. Move to new file position. Argument offset is a byte count. Optional argument whence defaults to 0 (offset from start of file, offset should be >= 0); other values are 1 (move relative to current position, positive or negative), and 2 (move relative to end of file, usually negative, although many platforms allow seeking beyond the end of a file). If the file is opened in text mode, only offsets returned by tell() are legal. Use of other offsets causes undefined behavior. Note that not all file objects are seekable.

modo.mprop.threading.warnings.types.FileType.softspace

type: getset_descriptor

doc: flag indicating that a space needs to be printed; used by print

modo.mprop.threading.warnings.types.FileType.tell()

type: method_descriptor

doc: tell() -> current file position, an integer (may be a long integer).

modo.mprop.threading.warnings.types.FileType.truncate()

type: method_descriptor

doc: truncate([size]) -> None. Truncate the file to at most size bytes. Size defaults to the current file position, as returned by tell().

modo.mprop.threading.warnings.types.FileType.write()

type: method_descriptor

doc: write(str) -> None. Write string str to file. Note that due to buffering, flush() or close() may be needed before the file on disk reflects the data written.

modo.mprop.threading.warnings.types.FileType.writelines()

type: method_descriptor

doc: writelines(sequence_of_strings) -> None. Write the strings to the file. Note that newlines are not added. The sequence can be any iterable object producing strings. This is equivalent to calling write() for each string.

modo.mprop.threading.warnings.types.FileType.xreadlines()

type: method_descriptor

doc: xreadlines() -> returns self. For backward compatibility. File objects now include the performance optimizations previously implemented in the xreadlines module.

modo.mprop.threading.warnings.types.FloatType

type: type

doc: float(x) -> floating point number Convert a string or number to a floating point number, if possible.

    modo.mprop.threading.warnings.types.FloatType contents:
  • modo.mprop.threading.warnings.types.FloatType.__abs__
  • modo.mprop.threading.warnings.types.FloatType.__add__
  • modo.mprop.threading.warnings.types.FloatType.__class__
  • modo.mprop.threading.warnings.types.FloatType.__coerce__
  • modo.mprop.threading.warnings.types.FloatType.__delattr__
  • modo.mprop.threading.warnings.types.FloatType.__div__
  • modo.mprop.threading.warnings.types.FloatType.__divmod__
  • modo.mprop.threading.warnings.types.FloatType.__doc__
  • modo.mprop.threading.warnings.types.FloatType.__eq__
  • modo.mprop.threading.warnings.types.FloatType.__float__
  • modo.mprop.threading.warnings.types.FloatType.__floordiv__
  • modo.mprop.threading.warnings.types.FloatType.__format__
  • modo.mprop.threading.warnings.types.FloatType.__ge__
  • modo.mprop.threading.warnings.types.FloatType.__getattribute__
  • modo.mprop.threading.warnings.types.FloatType.__getformat__
  • modo.mprop.threading.warnings.types.FloatType.__getnewargs__
  • modo.mprop.threading.warnings.types.FloatType.__gt__
  • modo.mprop.threading.warnings.types.FloatType.__hash__
  • modo.mprop.threading.warnings.types.FloatType.__init__
  • modo.mprop.threading.warnings.types.FloatType.__int__
  • modo.mprop.threading.warnings.types.FloatType.__le__
  • modo.mprop.threading.warnings.types.FloatType.__long__
  • modo.mprop.threading.warnings.types.FloatType.__lt__
  • modo.mprop.threading.warnings.types.FloatType.__mod__
  • modo.mprop.threading.warnings.types.FloatType.__mul__
  • modo.mprop.threading.warnings.types.FloatType.__ne__
  • modo.mprop.threading.warnings.types.FloatType.__neg__
  • modo.mprop.threading.warnings.types.FloatType.__new__
  • modo.mprop.threading.warnings.types.FloatType.__nonzero__
  • modo.mprop.threading.warnings.types.FloatType.__pos__
  • modo.mprop.threading.warnings.types.FloatType.__pow__
  • modo.mprop.threading.warnings.types.FloatType.__radd__
  • modo.mprop.threading.warnings.types.FloatType.__rdiv__
  • modo.mprop.threading.warnings.types.FloatType.__rdivmod__
  • modo.mprop.threading.warnings.types.FloatType.__reduce__
  • modo.mprop.threading.warnings.types.FloatType.__reduce_ex__
  • modo.mprop.threading.warnings.types.FloatType.__repr__
  • modo.mprop.threading.warnings.types.FloatType.__rfloordiv__
  • modo.mprop.threading.warnings.types.FloatType.__rmod__
  • modo.mprop.threading.warnings.types.FloatType.__rmul__
  • modo.mprop.threading.warnings.types.FloatType.__rpow__
  • modo.mprop.threading.warnings.types.FloatType.__rsub__
  • modo.mprop.threading.warnings.types.FloatType.__rtruediv__
  • modo.mprop.threading.warnings.types.FloatType.__setattr__
  • modo.mprop.threading.warnings.types.FloatType.__setformat__
  • modo.mprop.threading.warnings.types.FloatType.__sizeof__
  • modo.mprop.threading.warnings.types.FloatType.__str__
  • modo.mprop.threading.warnings.types.FloatType.__sub__
  • modo.mprop.threading.warnings.types.FloatType.__subclasshook__
  • modo.mprop.threading.warnings.types.FloatType.__truediv__
  • modo.mprop.threading.warnings.types.FloatType.__trunc__
  • modo.mprop.threading.warnings.types.FloatType.as_integer_ratio
  • modo.mprop.threading.warnings.types.FloatType.conjugate
  • modo.mprop.threading.warnings.types.FloatType.fromhex
  • modo.mprop.threading.warnings.types.FloatType.hex
  • modo.mprop.threading.warnings.types.FloatType.imag
  • modo.mprop.threading.warnings.types.FloatType.is_integer
  • modo.mprop.threading.warnings.types.FloatType.real

modo.mprop.threading.warnings.types.FloatType.as_integer_ratio()

type: method_descriptor

doc: float.as_integer_ratio() -> (int, int) Returns a pair of integers, whose ratio is exactly equal to the original float and with a positive denominator. Raises OverflowError on infinities and a ValueError on NaNs. >>> (10.0).as_integer_ratio() (10, 1) >>> (0.0).as_integer_ratio() (0, 1) >>> (-.25).as_integer_ratio() (-1, 4)

modo.mprop.threading.warnings.types.FloatType.conjugate()

type: method_descriptor

doc: Returns self, the complex conjugate of any float.

modo.mprop.threading.warnings.types.FloatType.fromhex()

type: builtin_function_or_method

doc: float.fromhex(string) -> float Create a floating-point number from a hexadecimal string. >>> float.fromhex('0x1.ffffp10') 2047.984375 >>> float.fromhex('-0x1p-1074') -4.9406564584124654e-324

modo.mprop.threading.warnings.types.FloatType.hex()

type: method_descriptor

doc: float.hex() -> string Return a hexadecimal representation of a floating-point number. >>> (-0.1).hex() '-0x1.999999999999ap-4' >>> 3.14159.hex() '0x1.921f9f01b866ep+1'

modo.mprop.threading.warnings.types.FloatType.imag

type: getset_descriptor

doc: the imaginary part of a complex number

modo.mprop.threading.warnings.types.FloatType.is_integer()

type: method_descriptor

doc: Returns True if the float is an integer.

modo.mprop.threading.warnings.types.FloatType.real

type: getset_descriptor

doc: the real part of a complex number

modo.mprop.threading.warnings.types.FrameType

type: type

modo.mprop.threading.warnings.types.FrameType.f_back

type: member_descriptor

modo.mprop.threading.warnings.types.FrameType.f_builtins

type: member_descriptor

modo.mprop.threading.warnings.types.FrameType.f_code

type: member_descriptor

modo.mprop.threading.warnings.types.FrameType.f_exc_traceback

type: getset_descriptor

modo.mprop.threading.warnings.types.FrameType.f_exc_type

type: getset_descriptor

modo.mprop.threading.warnings.types.FrameType.f_exc_value

type: getset_descriptor

modo.mprop.threading.warnings.types.FrameType.f_globals

type: member_descriptor

modo.mprop.threading.warnings.types.FrameType.f_lasti

type: member_descriptor

modo.mprop.threading.warnings.types.FrameType.f_lineno

type: getset_descriptor

modo.mprop.threading.warnings.types.FrameType.f_locals

type: getset_descriptor

modo.mprop.threading.warnings.types.FrameType.f_restricted

type: getset_descriptor

modo.mprop.threading.warnings.types.FrameType.f_trace

type: getset_descriptor

modo.mprop.threading.warnings.types.FunctionType

type: type

doc: function(code, globals[, name[, argdefs[, closure]]]) Create a function object from a code object and a dictionary. The optional name string overrides the name from the code object. The optional argdefs tuple specifies the default argument values. The optional closure tuple supplies the bindings for free variables.

modo.mprop.threading.warnings.types.FunctionType.func_closure

type: member_descriptor

modo.mprop.threading.warnings.types.FunctionType.func_code

type: getset_descriptor

modo.mprop.threading.warnings.types.FunctionType.func_defaults

type: getset_descriptor

modo.mprop.threading.warnings.types.FunctionType.func_dict

type: getset_descriptor

modo.mprop.threading.warnings.types.FunctionType.func_doc

type: member_descriptor

modo.mprop.threading.warnings.types.FunctionType.func_globals

type: member_descriptor

modo.mprop.threading.warnings.types.FunctionType.func_name

type: getset_descriptor

modo.mprop.threading.warnings.types.GeneratorType

type: type

modo.mprop.threading.warnings.types.GeneratorType.close()

type: method_descriptor

doc: close(arg) -> raise GeneratorExit inside generator.

modo.mprop.threading.warnings.types.GeneratorType.gi_code

type: member_descriptor

modo.mprop.threading.warnings.types.GeneratorType.gi_frame

type: member_descriptor

modo.mprop.threading.warnings.types.GeneratorType.gi_running

type: member_descriptor

modo.mprop.threading.warnings.types.GeneratorType.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.mprop.threading.warnings.types.GeneratorType.send()

type: method_descriptor

doc: send(arg) -> send 'arg' into generator, return next yielded value or raise StopIteration.

modo.mprop.threading.warnings.types.GeneratorType.throw()

type: method_descriptor

doc: throw(typ[,val[,tb]]) -> raise exception in generator, return next yielded value or raise StopIteration.

modo.mprop.threading.warnings.types.GetSetDescriptorType

type: type

    modo.mprop.threading.warnings.types.GetSetDescriptorType contents:
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__class__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__delattr__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__delete__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__doc__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__format__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__get__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__getattribute__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__hash__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__init__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__name__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__new__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__objclass__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__reduce__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__reduce_ex__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__repr__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__set__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__setattr__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__sizeof__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__str__
  • modo.mprop.threading.warnings.types.GetSetDescriptorType.__subclasshook__
modo.mprop.threading.warnings.types.InstanceType

type: type

doc: instance(class[, dict]) Create an instance without calling its __init__() method. The class must be a classic class. If present, dict must be a dictionary or None.

    modo.mprop.threading.warnings.types.InstanceType contents:
  • modo.mprop.threading.warnings.types.InstanceType.__abs__
  • modo.mprop.threading.warnings.types.InstanceType.__add__
  • modo.mprop.threading.warnings.types.InstanceType.__and__
  • modo.mprop.threading.warnings.types.InstanceType.__call__
  • modo.mprop.threading.warnings.types.InstanceType.__class__
  • modo.mprop.threading.warnings.types.InstanceType.__cmp__
  • modo.mprop.threading.warnings.types.InstanceType.__coerce__
  • modo.mprop.threading.warnings.types.InstanceType.__contains__
  • modo.mprop.threading.warnings.types.InstanceType.__delattr__
  • modo.mprop.threading.warnings.types.InstanceType.__delitem__
  • modo.mprop.threading.warnings.types.InstanceType.__delslice__
  • modo.mprop.threading.warnings.types.InstanceType.__div__
  • modo.mprop.threading.warnings.types.InstanceType.__divmod__
  • modo.mprop.threading.warnings.types.InstanceType.__doc__
  • modo.mprop.threading.warnings.types.InstanceType.__eq__
  • modo.mprop.threading.warnings.types.InstanceType.__float__
  • modo.mprop.threading.warnings.types.InstanceType.__floordiv__
  • modo.mprop.threading.warnings.types.InstanceType.__format__
  • modo.mprop.threading.warnings.types.InstanceType.__ge__
  • modo.mprop.threading.warnings.types.InstanceType.__getattribute__
  • modo.mprop.threading.warnings.types.InstanceType.__getitem__
  • modo.mprop.threading.warnings.types.InstanceType.__getslice__
  • modo.mprop.threading.warnings.types.InstanceType.__gt__
  • modo.mprop.threading.warnings.types.InstanceType.__hash__
  • modo.mprop.threading.warnings.types.InstanceType.__hex__
  • modo.mprop.threading.warnings.types.InstanceType.__iadd__
  • modo.mprop.threading.warnings.types.InstanceType.__iand__
  • modo.mprop.threading.warnings.types.InstanceType.__idiv__
  • modo.mprop.threading.warnings.types.InstanceType.__ifloordiv__
  • modo.mprop.threading.warnings.types.InstanceType.__ilshift__
  • modo.mprop.threading.warnings.types.InstanceType.__imod__
  • modo.mprop.threading.warnings.types.InstanceType.__imul__
  • modo.mprop.threading.warnings.types.InstanceType.__index__
  • modo.mprop.threading.warnings.types.InstanceType.__init__
  • modo.mprop.threading.warnings.types.InstanceType.__int__
  • modo.mprop.threading.warnings.types.InstanceType.__invert__
  • modo.mprop.threading.warnings.types.InstanceType.__ior__
  • modo.mprop.threading.warnings.types.InstanceType.__ipow__
  • modo.mprop.threading.warnings.types.InstanceType.__irshift__
  • modo.mprop.threading.warnings.types.InstanceType.__isub__
  • modo.mprop.threading.warnings.types.InstanceType.__iter__
  • modo.mprop.threading.warnings.types.InstanceType.__itruediv__
  • modo.mprop.threading.warnings.types.InstanceType.__ixor__
  • modo.mprop.threading.warnings.types.InstanceType.__le__
  • modo.mprop.threading.warnings.types.InstanceType.__len__
  • modo.mprop.threading.warnings.types.InstanceType.__long__
  • modo.mprop.threading.warnings.types.InstanceType.__lshift__
  • modo.mprop.threading.warnings.types.InstanceType.__lt__
  • modo.mprop.threading.warnings.types.InstanceType.__mod__
  • modo.mprop.threading.warnings.types.InstanceType.__mul__
  • modo.mprop.threading.warnings.types.InstanceType.__ne__
  • modo.mprop.threading.warnings.types.InstanceType.__neg__
  • modo.mprop.threading.warnings.types.InstanceType.__new__
  • modo.mprop.threading.warnings.types.InstanceType.__nonzero__
  • modo.mprop.threading.warnings.types.InstanceType.__oct__
  • modo.mprop.threading.warnings.types.InstanceType.__or__
  • modo.mprop.threading.warnings.types.InstanceType.__pos__
  • modo.mprop.threading.warnings.types.InstanceType.__pow__
  • modo.mprop.threading.warnings.types.InstanceType.__radd__
  • modo.mprop.threading.warnings.types.InstanceType.__rand__
  • modo.mprop.threading.warnings.types.InstanceType.__rdiv__
  • modo.mprop.threading.warnings.types.InstanceType.__rdivmod__
  • modo.mprop.threading.warnings.types.InstanceType.__reduce__
  • modo.mprop.threading.warnings.types.InstanceType.__reduce_ex__
  • modo.mprop.threading.warnings.types.InstanceType.__repr__
  • modo.mprop.threading.warnings.types.InstanceType.__rfloordiv__
  • modo.mprop.threading.warnings.types.InstanceType.__rlshift__
  • modo.mprop.threading.warnings.types.InstanceType.__rmod__
  • modo.mprop.threading.warnings.types.InstanceType.__rmul__
  • modo.mprop.threading.warnings.types.InstanceType.__ror__
  • modo.mprop.threading.warnings.types.InstanceType.__rpow__
  • modo.mprop.threading.warnings.types.InstanceType.__rrshift__
  • modo.mprop.threading.warnings.types.InstanceType.__rshift__
  • modo.mprop.threading.warnings.types.InstanceType.__rsub__
  • modo.mprop.threading.warnings.types.InstanceType.__rtruediv__
  • modo.mprop.threading.warnings.types.InstanceType.__rxor__
  • modo.mprop.threading.warnings.types.InstanceType.__setattr__
  • modo.mprop.threading.warnings.types.InstanceType.__setitem__
  • modo.mprop.threading.warnings.types.InstanceType.__setslice__
  • modo.mprop.threading.warnings.types.InstanceType.__sizeof__
  • modo.mprop.threading.warnings.types.InstanceType.__str__
  • modo.mprop.threading.warnings.types.InstanceType.__sub__
  • modo.mprop.threading.warnings.types.InstanceType.__subclasshook__
  • modo.mprop.threading.warnings.types.InstanceType.__truediv__
  • modo.mprop.threading.warnings.types.InstanceType.__xor__
  • modo.mprop.threading.warnings.types.InstanceType.next

modo.mprop.threading.warnings.types.InstanceType.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.mprop.threading.warnings.types.IntType

type: type

doc: int(x[, base]) -> integer Convert a string or number to an integer, if possible. A floating point argument will be truncated towards zero (this does not include a string representation of a floating point number!) When converting a string, use the optional base. It is an error to supply a base when converting a non-string. If base is zero, the proper base is guessed based on the string content. If the argument is outside the integer range a long object will be returned instead.

    modo.mprop.threading.warnings.types.IntType contents:
  • modo.mprop.threading.warnings.types.IntType.__abs__
  • modo.mprop.threading.warnings.types.IntType.__add__
  • modo.mprop.threading.warnings.types.IntType.__and__
  • modo.mprop.threading.warnings.types.IntType.__class__
  • modo.mprop.threading.warnings.types.IntType.__cmp__
  • modo.mprop.threading.warnings.types.IntType.__coerce__
  • modo.mprop.threading.warnings.types.IntType.__delattr__
  • modo.mprop.threading.warnings.types.IntType.__div__
  • modo.mprop.threading.warnings.types.IntType.__divmod__
  • modo.mprop.threading.warnings.types.IntType.__doc__
  • modo.mprop.threading.warnings.types.IntType.__float__
  • modo.mprop.threading.warnings.types.IntType.__floordiv__
  • modo.mprop.threading.warnings.types.IntType.__format__
  • modo.mprop.threading.warnings.types.IntType.__getattribute__
  • modo.mprop.threading.warnings.types.IntType.__getnewargs__
  • modo.mprop.threading.warnings.types.IntType.__hash__
  • modo.mprop.threading.warnings.types.IntType.__hex__
  • modo.mprop.threading.warnings.types.IntType.__index__
  • modo.mprop.threading.warnings.types.IntType.__init__
  • modo.mprop.threading.warnings.types.IntType.__int__
  • modo.mprop.threading.warnings.types.IntType.__invert__
  • modo.mprop.threading.warnings.types.IntType.__long__
  • modo.mprop.threading.warnings.types.IntType.__lshift__
  • modo.mprop.threading.warnings.types.IntType.__mod__
  • modo.mprop.threading.warnings.types.IntType.__mul__
  • modo.mprop.threading.warnings.types.IntType.__neg__
  • modo.mprop.threading.warnings.types.IntType.__new__
  • modo.mprop.threading.warnings.types.IntType.__nonzero__
  • modo.mprop.threading.warnings.types.IntType.__oct__
  • modo.mprop.threading.warnings.types.IntType.__or__
  • modo.mprop.threading.warnings.types.IntType.__pos__
  • modo.mprop.threading.warnings.types.IntType.__pow__
  • modo.mprop.threading.warnings.types.IntType.__radd__
  • modo.mprop.threading.warnings.types.IntType.__rand__
  • modo.mprop.threading.warnings.types.IntType.__rdiv__
  • modo.mprop.threading.warnings.types.IntType.__rdivmod__
  • modo.mprop.threading.warnings.types.IntType.__reduce__
  • modo.mprop.threading.warnings.types.IntType.__reduce_ex__
  • modo.mprop.threading.warnings.types.IntType.__repr__
  • modo.mprop.threading.warnings.types.IntType.__rfloordiv__
  • modo.mprop.threading.warnings.types.IntType.__rlshift__
  • modo.mprop.threading.warnings.types.IntType.__rmod__
  • modo.mprop.threading.warnings.types.IntType.__rmul__
  • modo.mprop.threading.warnings.types.IntType.__ror__
  • modo.mprop.threading.warnings.types.IntType.__rpow__
  • modo.mprop.threading.warnings.types.IntType.__rrshift__
  • modo.mprop.threading.warnings.types.IntType.__rshift__
  • modo.mprop.threading.warnings.types.IntType.__rsub__
  • modo.mprop.threading.warnings.types.IntType.__rtruediv__
  • modo.mprop.threading.warnings.types.IntType.__rxor__
  • modo.mprop.threading.warnings.types.IntType.__setattr__
  • modo.mprop.threading.warnings.types.IntType.__sizeof__
  • modo.mprop.threading.warnings.types.IntType.__str__
  • modo.mprop.threading.warnings.types.IntType.__sub__
  • modo.mprop.threading.warnings.types.IntType.__subclasshook__
  • modo.mprop.threading.warnings.types.IntType.__truediv__
  • modo.mprop.threading.warnings.types.IntType.__trunc__
  • modo.mprop.threading.warnings.types.IntType.__xor__
  • modo.mprop.threading.warnings.types.IntType.bit_length
  • modo.mprop.threading.warnings.types.IntType.conjugate
  • modo.mprop.threading.warnings.types.IntType.denominator
  • modo.mprop.threading.warnings.types.IntType.imag
  • modo.mprop.threading.warnings.types.IntType.numerator
  • modo.mprop.threading.warnings.types.IntType.real

modo.mprop.threading.warnings.types.IntType.bit_length()

type: method_descriptor

doc: int.bit_length() -> int Number of bits necessary to represent self in binary. >>> bin(37) '0b100101' >>> (37).bit_length() 6

modo.mprop.threading.warnings.types.IntType.conjugate()

type: method_descriptor

doc: Returns self, the complex conjugate of any int.

modo.mprop.threading.warnings.types.IntType.denominator

type: getset_descriptor

doc: the denominator of a rational number in lowest terms

modo.mprop.threading.warnings.types.IntType.imag

type: getset_descriptor

doc: the imaginary part of a complex number

modo.mprop.threading.warnings.types.IntType.numerator

type: getset_descriptor

doc: the numerator of a rational number in lowest terms

modo.mprop.threading.warnings.types.IntType.real

type: getset_descriptor

doc: the real part of a complex number

modo.mprop.threading.warnings.types.LambdaType

type: type

doc: function(code, globals[, name[, argdefs[, closure]]]) Create a function object from a code object and a dictionary. The optional name string overrides the name from the code object. The optional argdefs tuple specifies the default argument values. The optional closure tuple supplies the bindings for free variables.

modo.mprop.threading.warnings.types.LambdaType.func_closure

type: member_descriptor

modo.mprop.threading.warnings.types.LambdaType.func_code

type: getset_descriptor

modo.mprop.threading.warnings.types.LambdaType.func_defaults

type: getset_descriptor

modo.mprop.threading.warnings.types.LambdaType.func_dict

type: getset_descriptor

modo.mprop.threading.warnings.types.LambdaType.func_doc

type: member_descriptor

modo.mprop.threading.warnings.types.LambdaType.func_globals

type: member_descriptor

modo.mprop.threading.warnings.types.LambdaType.func_name

type: getset_descriptor

modo.mprop.threading.warnings.types.ListType

type: type

doc: list() -> new empty list list(iterable) -> new list initialized from iterable's items

    modo.mprop.threading.warnings.types.ListType contents:
  • modo.mprop.threading.warnings.types.ListType.__add__
  • modo.mprop.threading.warnings.types.ListType.__class__
  • modo.mprop.threading.warnings.types.ListType.__contains__
  • modo.mprop.threading.warnings.types.ListType.__delattr__
  • modo.mprop.threading.warnings.types.ListType.__delitem__
  • modo.mprop.threading.warnings.types.ListType.__delslice__
  • modo.mprop.threading.warnings.types.ListType.__doc__
  • modo.mprop.threading.warnings.types.ListType.__eq__
  • modo.mprop.threading.warnings.types.ListType.__format__
  • modo.mprop.threading.warnings.types.ListType.__ge__
  • modo.mprop.threading.warnings.types.ListType.__getattribute__
  • modo.mprop.threading.warnings.types.ListType.__getitem__
  • modo.mprop.threading.warnings.types.ListType.__getslice__
  • modo.mprop.threading.warnings.types.ListType.__gt__
  • modo.mprop.threading.warnings.types.ListType.__hash__
  • modo.mprop.threading.warnings.types.ListType.__iadd__
  • modo.mprop.threading.warnings.types.ListType.__imul__
  • modo.mprop.threading.warnings.types.ListType.__init__
  • modo.mprop.threading.warnings.types.ListType.__iter__
  • modo.mprop.threading.warnings.types.ListType.__le__
  • modo.mprop.threading.warnings.types.ListType.__len__
  • modo.mprop.threading.warnings.types.ListType.__lt__
  • modo.mprop.threading.warnings.types.ListType.__mul__
  • modo.mprop.threading.warnings.types.ListType.__ne__
  • modo.mprop.threading.warnings.types.ListType.__new__
  • modo.mprop.threading.warnings.types.ListType.__reduce__
  • modo.mprop.threading.warnings.types.ListType.__reduce_ex__
  • modo.mprop.threading.warnings.types.ListType.__repr__
  • modo.mprop.threading.warnings.types.ListType.__reversed__
  • modo.mprop.threading.warnings.types.ListType.__rmul__
  • modo.mprop.threading.warnings.types.ListType.__setattr__
  • modo.mprop.threading.warnings.types.ListType.__setitem__
  • modo.mprop.threading.warnings.types.ListType.__setslice__
  • modo.mprop.threading.warnings.types.ListType.__sizeof__
  • modo.mprop.threading.warnings.types.ListType.__str__
  • modo.mprop.threading.warnings.types.ListType.__subclasshook__
  • modo.mprop.threading.warnings.types.ListType.append
  • modo.mprop.threading.warnings.types.ListType.count
  • modo.mprop.threading.warnings.types.ListType.extend
  • modo.mprop.threading.warnings.types.ListType.index
  • modo.mprop.threading.warnings.types.ListType.insert
  • modo.mprop.threading.warnings.types.ListType.pop
  • modo.mprop.threading.warnings.types.ListType.remove
  • modo.mprop.threading.warnings.types.ListType.reverse
  • modo.mprop.threading.warnings.types.ListType.sort

modo.mprop.threading.warnings.types.ListType.append()

type: method_descriptor

doc: L.append(object) -- append object to end

modo.mprop.threading.warnings.types.ListType.count()

type: method_descriptor

doc: L.count(value) -> integer -- return number of occurrences of value

modo.mprop.threading.warnings.types.ListType.extend()

type: method_descriptor

doc: L.extend(iterable) -- extend list by appending elements from the iterable

modo.mprop.threading.warnings.types.ListType.index()

type: method_descriptor

doc: L.index(value, [start, [stop]]) -> integer -- return first index of value. Raises ValueError if the value is not present.

modo.mprop.threading.warnings.types.ListType.insert()

type: method_descriptor

doc: L.insert(index, object) -- insert object before index

modo.mprop.threading.warnings.types.ListType.pop()

type: method_descriptor

doc: L.pop([index]) -> item -- remove and return item at index (default last). Raises IndexError if list is empty or index is out of range.

modo.mprop.threading.warnings.types.ListType.remove()

type: method_descriptor

doc: L.remove(value) -- remove first occurrence of value. Raises ValueError if the value is not present.

modo.mprop.threading.warnings.types.ListType.reverse()

type: method_descriptor

doc: L.reverse() -- reverse *IN PLACE*

modo.mprop.threading.warnings.types.ListType.sort()

type: method_descriptor

doc: L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*; cmp(x, y) -> -1, 0, 1

modo.mprop.threading.warnings.types.LongType

type: type

doc: long(x[, base]) -> integer Convert a string or number to a long integer, if possible. A floating point argument will be truncated towards zero (this does not include a string representation of a floating point number!) When converting a string, use the optional base. It is an error to supply a base when converting a non-string.

    modo.mprop.threading.warnings.types.LongType contents:
  • modo.mprop.threading.warnings.types.LongType.__abs__
  • modo.mprop.threading.warnings.types.LongType.__add__
  • modo.mprop.threading.warnings.types.LongType.__and__
  • modo.mprop.threading.warnings.types.LongType.__class__
  • modo.mprop.threading.warnings.types.LongType.__cmp__
  • modo.mprop.threading.warnings.types.LongType.__coerce__
  • modo.mprop.threading.warnings.types.LongType.__delattr__
  • modo.mprop.threading.warnings.types.LongType.__div__
  • modo.mprop.threading.warnings.types.LongType.__divmod__
  • modo.mprop.threading.warnings.types.LongType.__doc__
  • modo.mprop.threading.warnings.types.LongType.__float__
  • modo.mprop.threading.warnings.types.LongType.__floordiv__
  • modo.mprop.threading.warnings.types.LongType.__format__
  • modo.mprop.threading.warnings.types.LongType.__getattribute__
  • modo.mprop.threading.warnings.types.LongType.__getnewargs__
  • modo.mprop.threading.warnings.types.LongType.__hash__
  • modo.mprop.threading.warnings.types.LongType.__hex__
  • modo.mprop.threading.warnings.types.LongType.__index__
  • modo.mprop.threading.warnings.types.LongType.__init__
  • modo.mprop.threading.warnings.types.LongType.__int__
  • modo.mprop.threading.warnings.types.LongType.__invert__
  • modo.mprop.threading.warnings.types.LongType.__long__
  • modo.mprop.threading.warnings.types.LongType.__lshift__
  • modo.mprop.threading.warnings.types.LongType.__mod__
  • modo.mprop.threading.warnings.types.LongType.__mul__
  • modo.mprop.threading.warnings.types.LongType.__neg__
  • modo.mprop.threading.warnings.types.LongType.__new__
  • modo.mprop.threading.warnings.types.LongType.__nonzero__
  • modo.mprop.threading.warnings.types.LongType.__oct__
  • modo.mprop.threading.warnings.types.LongType.__or__
  • modo.mprop.threading.warnings.types.LongType.__pos__
  • modo.mprop.threading.warnings.types.LongType.__pow__
  • modo.mprop.threading.warnings.types.LongType.__radd__
  • modo.mprop.threading.warnings.types.LongType.__rand__
  • modo.mprop.threading.warnings.types.LongType.__rdiv__
  • modo.mprop.threading.warnings.types.LongType.__rdivmod__
  • modo.mprop.threading.warnings.types.LongType.__reduce__
  • modo.mprop.threading.warnings.types.LongType.__reduce_ex__
  • modo.mprop.threading.warnings.types.LongType.__repr__
  • modo.mprop.threading.warnings.types.LongType.__rfloordiv__
  • modo.mprop.threading.warnings.types.LongType.__rlshift__
  • modo.mprop.threading.warnings.types.LongType.__rmod__
  • modo.mprop.threading.warnings.types.LongType.__rmul__
  • modo.mprop.threading.warnings.types.LongType.__ror__
  • modo.mprop.threading.warnings.types.LongType.__rpow__
  • modo.mprop.threading.warnings.types.LongType.__rrshift__
  • modo.mprop.threading.warnings.types.LongType.__rshift__
  • modo.mprop.threading.warnings.types.LongType.__rsub__
  • modo.mprop.threading.warnings.types.LongType.__rtruediv__
  • modo.mprop.threading.warnings.types.LongType.__rxor__
  • modo.mprop.threading.warnings.types.LongType.__setattr__
  • modo.mprop.threading.warnings.types.LongType.__sizeof__
  • modo.mprop.threading.warnings.types.LongType.__str__
  • modo.mprop.threading.warnings.types.LongType.__sub__
  • modo.mprop.threading.warnings.types.LongType.__subclasshook__
  • modo.mprop.threading.warnings.types.LongType.__truediv__
  • modo.mprop.threading.warnings.types.LongType.__trunc__
  • modo.mprop.threading.warnings.types.LongType.__xor__
  • modo.mprop.threading.warnings.types.LongType.bit_length
  • modo.mprop.threading.warnings.types.LongType.conjugate
  • modo.mprop.threading.warnings.types.LongType.denominator
  • modo.mprop.threading.warnings.types.LongType.imag
  • modo.mprop.threading.warnings.types.LongType.numerator
  • modo.mprop.threading.warnings.types.LongType.real

modo.mprop.threading.warnings.types.LongType.bit_length()

type: method_descriptor

doc: long.bit_length() -> int or long Number of bits necessary to represent self in binary. >>> bin(37L) '0b100101' >>> (37L).bit_length() 6

modo.mprop.threading.warnings.types.LongType.conjugate()

type: method_descriptor

doc: Returns self, the complex conjugate of any long.

modo.mprop.threading.warnings.types.LongType.denominator

type: getset_descriptor

doc: the denominator of a rational number in lowest terms

modo.mprop.threading.warnings.types.LongType.imag

type: getset_descriptor

doc: the imaginary part of a complex number

modo.mprop.threading.warnings.types.LongType.numerator

type: getset_descriptor

doc: the numerator of a rational number in lowest terms

modo.mprop.threading.warnings.types.LongType.real

type: getset_descriptor

doc: the real part of a complex number

modo.mprop.threading.warnings.types.MemberDescriptorType

type: type

    modo.mprop.threading.warnings.types.MemberDescriptorType contents:
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__class__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__delattr__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__delete__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__doc__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__format__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__get__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__getattribute__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__hash__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__init__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__name__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__new__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__objclass__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__reduce__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__reduce_ex__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__repr__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__set__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__setattr__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__sizeof__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__str__
  • modo.mprop.threading.warnings.types.MemberDescriptorType.__subclasshook__
modo.mprop.threading.warnings.types.MethodType

type: type

doc: instancemethod(function, instance, class) Create an instance method object.

    modo.mprop.threading.warnings.types.MethodType contents:
  • modo.mprop.threading.warnings.types.MethodType.__call__
  • modo.mprop.threading.warnings.types.MethodType.__class__
  • modo.mprop.threading.warnings.types.MethodType.__cmp__
  • modo.mprop.threading.warnings.types.MethodType.__delattr__
  • modo.mprop.threading.warnings.types.MethodType.__doc__
  • modo.mprop.threading.warnings.types.MethodType.__format__
  • modo.mprop.threading.warnings.types.MethodType.__func__
  • modo.mprop.threading.warnings.types.MethodType.__get__
  • modo.mprop.threading.warnings.types.MethodType.__getattribute__
  • modo.mprop.threading.warnings.types.MethodType.__hash__
  • modo.mprop.threading.warnings.types.MethodType.__init__
  • modo.mprop.threading.warnings.types.MethodType.__new__
  • modo.mprop.threading.warnings.types.MethodType.__reduce__
  • modo.mprop.threading.warnings.types.MethodType.__reduce_ex__
  • modo.mprop.threading.warnings.types.MethodType.__repr__
  • modo.mprop.threading.warnings.types.MethodType.__self__
  • modo.mprop.threading.warnings.types.MethodType.__setattr__
  • modo.mprop.threading.warnings.types.MethodType.__sizeof__
  • modo.mprop.threading.warnings.types.MethodType.__str__
  • modo.mprop.threading.warnings.types.MethodType.__subclasshook__
  • modo.mprop.threading.warnings.types.MethodType.im_class
  • modo.mprop.threading.warnings.types.MethodType.im_func
  • modo.mprop.threading.warnings.types.MethodType.im_self

modo.mprop.threading.warnings.types.MethodType.im_class

type: member_descriptor

doc: the class associated with a method

modo.mprop.threading.warnings.types.MethodType.im_func

type: member_descriptor

doc: the function (or other callable) implementing a method

modo.mprop.threading.warnings.types.MethodType.im_self

type: member_descriptor

doc: the instance to which a method is bound; None for unbound methods

modo.mprop.threading.warnings.types.ModuleType

type: type

doc: module(name[, doc]) Create a module object. The name must be a string; the optional doc argument can have any type.

    modo.mprop.threading.warnings.types.ModuleType contents:
  • modo.mprop.threading.warnings.types.ModuleType.__class__
  • modo.mprop.threading.warnings.types.ModuleType.__delattr__
  • modo.mprop.threading.warnings.types.ModuleType.__dict__
  • modo.mprop.threading.warnings.types.ModuleType.__doc__
  • modo.mprop.threading.warnings.types.ModuleType.__format__
  • modo.mprop.threading.warnings.types.ModuleType.__getattribute__
  • modo.mprop.threading.warnings.types.ModuleType.__hash__
  • modo.mprop.threading.warnings.types.ModuleType.__init__
  • modo.mprop.threading.warnings.types.ModuleType.__new__
  • modo.mprop.threading.warnings.types.ModuleType.__reduce__
  • modo.mprop.threading.warnings.types.ModuleType.__reduce_ex__
  • modo.mprop.threading.warnings.types.ModuleType.__repr__
  • modo.mprop.threading.warnings.types.ModuleType.__setattr__
  • modo.mprop.threading.warnings.types.ModuleType.__sizeof__
  • modo.mprop.threading.warnings.types.ModuleType.__str__
  • modo.mprop.threading.warnings.types.ModuleType.__subclasshook__
modo.mprop.threading.warnings.types.NoneType

type: type

    modo.mprop.threading.warnings.types.NoneType contents:
  • modo.mprop.threading.warnings.types.NoneType.__class__
  • modo.mprop.threading.warnings.types.NoneType.__delattr__
  • modo.mprop.threading.warnings.types.NoneType.__doc__
  • modo.mprop.threading.warnings.types.NoneType.__format__
  • modo.mprop.threading.warnings.types.NoneType.__getattribute__
  • modo.mprop.threading.warnings.types.NoneType.__hash__
  • modo.mprop.threading.warnings.types.NoneType.__init__
  • modo.mprop.threading.warnings.types.NoneType.__new__
  • modo.mprop.threading.warnings.types.NoneType.__reduce__
  • modo.mprop.threading.warnings.types.NoneType.__reduce_ex__
  • modo.mprop.threading.warnings.types.NoneType.__repr__
  • modo.mprop.threading.warnings.types.NoneType.__setattr__
  • modo.mprop.threading.warnings.types.NoneType.__sizeof__
  • modo.mprop.threading.warnings.types.NoneType.__str__
  • modo.mprop.threading.warnings.types.NoneType.__subclasshook__
modo.mprop.threading.warnings.types.NotImplementedType

type: type

    modo.mprop.threading.warnings.types.NotImplementedType contents:
  • modo.mprop.threading.warnings.types.NotImplementedType.__class__
  • modo.mprop.threading.warnings.types.NotImplementedType.__delattr__
  • modo.mprop.threading.warnings.types.NotImplementedType.__doc__
  • modo.mprop.threading.warnings.types.NotImplementedType.__format__
  • modo.mprop.threading.warnings.types.NotImplementedType.__getattribute__
  • modo.mprop.threading.warnings.types.NotImplementedType.__hash__
  • modo.mprop.threading.warnings.types.NotImplementedType.__init__
  • modo.mprop.threading.warnings.types.NotImplementedType.__new__
  • modo.mprop.threading.warnings.types.NotImplementedType.__reduce__
  • modo.mprop.threading.warnings.types.NotImplementedType.__reduce_ex__
  • modo.mprop.threading.warnings.types.NotImplementedType.__repr__
  • modo.mprop.threading.warnings.types.NotImplementedType.__setattr__
  • modo.mprop.threading.warnings.types.NotImplementedType.__sizeof__
  • modo.mprop.threading.warnings.types.NotImplementedType.__str__
  • modo.mprop.threading.warnings.types.NotImplementedType.__subclasshook__
modo.mprop.threading.warnings.types.ObjectType

type: type

doc: The most base type

    modo.mprop.threading.warnings.types.ObjectType contents:
  • modo.mprop.threading.warnings.types.ObjectType.__class__
  • modo.mprop.threading.warnings.types.ObjectType.__delattr__
  • modo.mprop.threading.warnings.types.ObjectType.__doc__
  • modo.mprop.threading.warnings.types.ObjectType.__format__
  • modo.mprop.threading.warnings.types.ObjectType.__getattribute__
  • modo.mprop.threading.warnings.types.ObjectType.__hash__
  • modo.mprop.threading.warnings.types.ObjectType.__init__
  • modo.mprop.threading.warnings.types.ObjectType.__new__
  • modo.mprop.threading.warnings.types.ObjectType.__reduce__
  • modo.mprop.threading.warnings.types.ObjectType.__reduce_ex__
  • modo.mprop.threading.warnings.types.ObjectType.__repr__
  • modo.mprop.threading.warnings.types.ObjectType.__setattr__
  • modo.mprop.threading.warnings.types.ObjectType.__sizeof__
  • modo.mprop.threading.warnings.types.ObjectType.__str__
  • modo.mprop.threading.warnings.types.ObjectType.__subclasshook__
modo.mprop.threading.warnings.types.SliceType

type: type

doc: slice([start,] stop[, step]) Create a slice object. This is used for extended slicing (e.g. a[0:10:2]).

    modo.mprop.threading.warnings.types.SliceType contents:
  • modo.mprop.threading.warnings.types.SliceType.__class__
  • modo.mprop.threading.warnings.types.SliceType.__cmp__
  • modo.mprop.threading.warnings.types.SliceType.__delattr__
  • modo.mprop.threading.warnings.types.SliceType.__doc__
  • modo.mprop.threading.warnings.types.SliceType.__format__
  • modo.mprop.threading.warnings.types.SliceType.__getattribute__
  • modo.mprop.threading.warnings.types.SliceType.__hash__
  • modo.mprop.threading.warnings.types.SliceType.__init__
  • modo.mprop.threading.warnings.types.SliceType.__new__
  • modo.mprop.threading.warnings.types.SliceType.__reduce__
  • modo.mprop.threading.warnings.types.SliceType.__reduce_ex__
  • modo.mprop.threading.warnings.types.SliceType.__repr__
  • modo.mprop.threading.warnings.types.SliceType.__setattr__
  • modo.mprop.threading.warnings.types.SliceType.__sizeof__
  • modo.mprop.threading.warnings.types.SliceType.__str__
  • modo.mprop.threading.warnings.types.SliceType.__subclasshook__
  • modo.mprop.threading.warnings.types.SliceType.indices
  • modo.mprop.threading.warnings.types.SliceType.start
  • modo.mprop.threading.warnings.types.SliceType.step
  • modo.mprop.threading.warnings.types.SliceType.stop

modo.mprop.threading.warnings.types.SliceType.indices()

type: method_descriptor

doc: S.indices(len) -> (start, stop, stride) Assuming a sequence of length len, calculate the start and stop indices, and the stride length of the extended slice described by S. Out of bounds indices are clipped in a manner consistent with the handling of normal slices.

modo.mprop.threading.warnings.types.SliceType.start

type: member_descriptor

modo.mprop.threading.warnings.types.SliceType.step

type: member_descriptor

modo.mprop.threading.warnings.types.SliceType.stop

type: member_descriptor

modo.mprop.threading.warnings.types.StringType

type: type

doc: str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

modo.mprop.threading.warnings.types.StringType._formatter_field_name_split()

type: method_descriptor

modo.mprop.threading.warnings.types.StringType._formatter_parser()

type: method_descriptor

modo.mprop.threading.warnings.types.StringType.capitalize()

type: method_descriptor

doc: S.capitalize() -> string Return a copy of the string S with only its first character capitalized.

modo.mprop.threading.warnings.types.StringType.center()

type: method_descriptor

doc: S.center(width[, fillchar]) -> string Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

modo.mprop.threading.warnings.types.StringType.count()

type: method_descriptor

doc: S.count(sub[, start[, end]]) -> int Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

modo.mprop.threading.warnings.types.StringType.decode()

type: method_descriptor

doc: S.decode([encoding[,errors]]) -> object Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is 'strict' meaning that encoding errors raise a UnicodeDecodeError. Other possible values are 'ignore' and 'replace' as well as any other name registered with codecs.register_error that is able to handle UnicodeDecodeErrors.

modo.mprop.threading.warnings.types.StringType.encode()

type: method_descriptor

doc: S.encode([encoding[,errors]]) -> object Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is 'strict' meaning that encoding errors raise a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and 'xmlcharrefreplace' as well as any other name registered with codecs.register_error that is able to handle UnicodeEncodeErrors.

modo.mprop.threading.warnings.types.StringType.endswith()

type: method_descriptor

doc: S.endswith(suffix[, start[, end]]) -> bool Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

modo.mprop.threading.warnings.types.StringType.expandtabs()

type: method_descriptor

doc: S.expandtabs([tabsize]) -> string Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

modo.mprop.threading.warnings.types.StringType.find()

type: method_descriptor

doc: S.find(sub [,start [,end]]) -> int Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.

modo.mprop.threading.warnings.types.StringType.format()

type: method_descriptor

doc: S.format(*args, **kwargs) -> string Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

modo.mprop.threading.warnings.types.StringType.index()

type: method_descriptor

doc: S.index(sub [,start [,end]]) -> int Like S.find() but raise ValueError when the substring is not found.

modo.mprop.threading.warnings.types.StringType.isalnum()

type: method_descriptor

doc: S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

modo.mprop.threading.warnings.types.StringType.isalpha()

type: method_descriptor

doc: S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

modo.mprop.threading.warnings.types.StringType.isdigit()

type: method_descriptor

doc: S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

modo.mprop.threading.warnings.types.StringType.islower()

type: method_descriptor

doc: S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

modo.mprop.threading.warnings.types.StringType.isspace()

type: method_descriptor

doc: S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

modo.mprop.threading.warnings.types.StringType.istitle()

type: method_descriptor

doc: S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. uppercase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

modo.mprop.threading.warnings.types.StringType.isupper()

type: method_descriptor

doc: S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

modo.mprop.threading.warnings.types.StringType.join()

type: method_descriptor

doc: S.join(iterable) -> string Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

modo.mprop.threading.warnings.types.StringType.ljust()

type: method_descriptor

doc: S.ljust(width[, fillchar]) -> string Return S left-justified in a string of length width. Padding is done using the specified fill character (default is a space).

modo.mprop.threading.warnings.types.StringType.lower()

type: method_descriptor

doc: S.lower() -> string Return a copy of the string S converted to lowercase.

modo.mprop.threading.warnings.types.StringType.lstrip()

type: method_descriptor

doc: S.lstrip([chars]) -> string or unicode Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

modo.mprop.threading.warnings.types.StringType.partition()

type: method_descriptor

doc: S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

modo.mprop.threading.warnings.types.StringType.replace()

type: method_descriptor

doc: S.replace(old, new[, count]) -> string Return a copy of string S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

modo.mprop.threading.warnings.types.StringType.rfind()

type: method_descriptor

doc: S.rfind(sub [,start [,end]]) -> int Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.

modo.mprop.threading.warnings.types.StringType.rindex()

type: method_descriptor

doc: S.rindex(sub [,start [,end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

modo.mprop.threading.warnings.types.StringType.rjust()

type: method_descriptor

doc: S.rjust(width[, fillchar]) -> string Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space)

modo.mprop.threading.warnings.types.StringType.rpartition()

type: method_descriptor

doc: S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

modo.mprop.threading.warnings.types.StringType.rsplit()

type: method_descriptor

doc: S.rsplit([sep [,maxsplit]]) -> list of strings Return a list of the words in the string S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator.

modo.mprop.threading.warnings.types.StringType.rstrip()

type: method_descriptor

doc: S.rstrip([chars]) -> string or unicode Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

modo.mprop.threading.warnings.types.StringType.split()

type: method_descriptor

doc: S.split([sep [,maxsplit]]) -> list of strings Return a list of the words in the string S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

modo.mprop.threading.warnings.types.StringType.splitlines()

type: method_descriptor

doc: S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

modo.mprop.threading.warnings.types.StringType.startswith()

type: method_descriptor

doc: S.startswith(prefix[, start[, end]]) -> bool Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

modo.mprop.threading.warnings.types.StringType.strip()

type: method_descriptor

doc: S.strip([chars]) -> string or unicode Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

modo.mprop.threading.warnings.types.StringType.swapcase()

type: method_descriptor

doc: S.swapcase() -> string Return a copy of the string S with uppercase characters converted to lowercase and vice versa.

modo.mprop.threading.warnings.types.StringType.title()

type: method_descriptor

doc: S.title() -> string Return a titlecased version of S, i.e. words start with uppercase characters, all remaining cased characters have lowercase.

modo.mprop.threading.warnings.types.StringType.translate()

type: method_descriptor

doc: S.translate(table [,deletechars]) -> string Return a copy of the string S, where all characters occurring in the optional argument deletechars are removed, and the remaining characters have been mapped through the given translation table, which must be a string of length 256 or None. If the table argument is None, no translation is applied and the operation simply removes the characters in deletechars.

modo.mprop.threading.warnings.types.StringType.upper()

type: method_descriptor

doc: S.upper() -> string Return a copy of the string S converted to uppercase.

modo.mprop.threading.warnings.types.StringType.zfill()

type: method_descriptor

doc: S.zfill(width) -> string Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

modo.mprop.threading.warnings.types.StringTypes

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.threading.warnings.types.TracebackType

type: type

    modo.mprop.threading.warnings.types.TracebackType contents:
  • modo.mprop.threading.warnings.types.TracebackType.__class__
  • modo.mprop.threading.warnings.types.TracebackType.__delattr__
  • modo.mprop.threading.warnings.types.TracebackType.__doc__
  • modo.mprop.threading.warnings.types.TracebackType.__format__
  • modo.mprop.threading.warnings.types.TracebackType.__getattribute__
  • modo.mprop.threading.warnings.types.TracebackType.__hash__
  • modo.mprop.threading.warnings.types.TracebackType.__init__
  • modo.mprop.threading.warnings.types.TracebackType.__new__
  • modo.mprop.threading.warnings.types.TracebackType.__reduce__
  • modo.mprop.threading.warnings.types.TracebackType.__reduce_ex__
  • modo.mprop.threading.warnings.types.TracebackType.__repr__
  • modo.mprop.threading.warnings.types.TracebackType.__setattr__
  • modo.mprop.threading.warnings.types.TracebackType.__sizeof__
  • modo.mprop.threading.warnings.types.TracebackType.__str__
  • modo.mprop.threading.warnings.types.TracebackType.__subclasshook__
  • modo.mprop.threading.warnings.types.TracebackType.tb_frame
  • modo.mprop.threading.warnings.types.TracebackType.tb_lasti
  • modo.mprop.threading.warnings.types.TracebackType.tb_lineno
  • modo.mprop.threading.warnings.types.TracebackType.tb_next

modo.mprop.threading.warnings.types.TracebackType.tb_frame

type: member_descriptor

modo.mprop.threading.warnings.types.TracebackType.tb_lasti

type: member_descriptor

modo.mprop.threading.warnings.types.TracebackType.tb_lineno

type: member_descriptor

modo.mprop.threading.warnings.types.TracebackType.tb_next

type: member_descriptor

modo.mprop.threading.warnings.types.TupleType

type: type

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

    modo.mprop.threading.warnings.types.TupleType contents:
  • modo.mprop.threading.warnings.types.TupleType.__add__
  • modo.mprop.threading.warnings.types.TupleType.__class__
  • modo.mprop.threading.warnings.types.TupleType.__contains__
  • modo.mprop.threading.warnings.types.TupleType.__delattr__
  • modo.mprop.threading.warnings.types.TupleType.__doc__
  • modo.mprop.threading.warnings.types.TupleType.__eq__
  • modo.mprop.threading.warnings.types.TupleType.__format__
  • modo.mprop.threading.warnings.types.TupleType.__ge__
  • modo.mprop.threading.warnings.types.TupleType.__getattribute__
  • modo.mprop.threading.warnings.types.TupleType.__getitem__
  • modo.mprop.threading.warnings.types.TupleType.__getnewargs__
  • modo.mprop.threading.warnings.types.TupleType.__getslice__
  • modo.mprop.threading.warnings.types.TupleType.__gt__
  • modo.mprop.threading.warnings.types.TupleType.__hash__
  • modo.mprop.threading.warnings.types.TupleType.__init__
  • modo.mprop.threading.warnings.types.TupleType.__iter__
  • modo.mprop.threading.warnings.types.TupleType.__le__
  • modo.mprop.threading.warnings.types.TupleType.__len__
  • modo.mprop.threading.warnings.types.TupleType.__lt__
  • modo.mprop.threading.warnings.types.TupleType.__mul__
  • modo.mprop.threading.warnings.types.TupleType.__ne__
  • modo.mprop.threading.warnings.types.TupleType.__new__
  • modo.mprop.threading.warnings.types.TupleType.__reduce__
  • modo.mprop.threading.warnings.types.TupleType.__reduce_ex__
  • modo.mprop.threading.warnings.types.TupleType.__repr__
  • modo.mprop.threading.warnings.types.TupleType.__rmul__
  • modo.mprop.threading.warnings.types.TupleType.__setattr__
  • modo.mprop.threading.warnings.types.TupleType.__sizeof__
  • modo.mprop.threading.warnings.types.TupleType.__str__
  • modo.mprop.threading.warnings.types.TupleType.__subclasshook__
  • modo.mprop.threading.warnings.types.TupleType.count
  • modo.mprop.threading.warnings.types.TupleType.index

modo.mprop.threading.warnings.types.TupleType.count()

type: method_descriptor

doc: T.count(value) -> integer -- return number of occurrences of value

modo.mprop.threading.warnings.types.TupleType.index()

type: method_descriptor

doc: T.index(value, [start, [stop]]) -> integer -- return first index of value. Raises ValueError if the value is not present.

modo.mprop.threading.warnings.types.TypeType

type: type

doc: type(object) -> the object's type type(name, bases, dict) -> a new type

    modo.mprop.threading.warnings.types.TypeType contents:
  • modo.mprop.threading.warnings.types.TypeType.__base__
  • modo.mprop.threading.warnings.types.TypeType.__bases__
  • modo.mprop.threading.warnings.types.TypeType.__basicsize__
  • modo.mprop.threading.warnings.types.TypeType.__call__
  • modo.mprop.threading.warnings.types.TypeType.__class__
  • modo.mprop.threading.warnings.types.TypeType.__delattr__
  • modo.mprop.threading.warnings.types.TypeType.__dict__
  • modo.mprop.threading.warnings.types.TypeType.__dictoffset__
  • modo.mprop.threading.warnings.types.TypeType.__doc__
  • modo.mprop.threading.warnings.types.TypeType.__eq__
  • modo.mprop.threading.warnings.types.TypeType.__flags__
  • modo.mprop.threading.warnings.types.TypeType.__format__
  • modo.mprop.threading.warnings.types.TypeType.__ge__
  • modo.mprop.threading.warnings.types.TypeType.__getattribute__
  • modo.mprop.threading.warnings.types.TypeType.__gt__
  • modo.mprop.threading.warnings.types.TypeType.__hash__
  • modo.mprop.threading.warnings.types.TypeType.__init__
  • modo.mprop.threading.warnings.types.TypeType.__instancecheck__
  • modo.mprop.threading.warnings.types.TypeType.__itemsize__
  • modo.mprop.threading.warnings.types.TypeType.__le__
  • modo.mprop.threading.warnings.types.TypeType.__lt__
  • modo.mprop.threading.warnings.types.TypeType.__module__
  • modo.mprop.threading.warnings.types.TypeType.__mro__
  • modo.mprop.threading.warnings.types.TypeType.__name__
  • modo.mprop.threading.warnings.types.TypeType.__ne__
  • modo.mprop.threading.warnings.types.TypeType.__new__
  • modo.mprop.threading.warnings.types.TypeType.__reduce__
  • modo.mprop.threading.warnings.types.TypeType.__reduce_ex__
  • modo.mprop.threading.warnings.types.TypeType.__repr__
  • modo.mprop.threading.warnings.types.TypeType.__setattr__
  • modo.mprop.threading.warnings.types.TypeType.__sizeof__
  • modo.mprop.threading.warnings.types.TypeType.__str__
  • modo.mprop.threading.warnings.types.TypeType.__subclasscheck__
  • modo.mprop.threading.warnings.types.TypeType.__subclasses__
  • modo.mprop.threading.warnings.types.TypeType.__subclasshook__
  • modo.mprop.threading.warnings.types.TypeType.__weakrefoffset__
  • modo.mprop.threading.warnings.types.TypeType.mro

modo.mprop.threading.warnings.types.TypeType.mro()

type: method_descriptor

doc: mro() -> list return a type's method resolution order

modo.mprop.threading.warnings.types.UnboundMethodType

type: type

doc: instancemethod(function, instance, class) Create an instance method object.

    modo.mprop.threading.warnings.types.UnboundMethodType contents:
  • modo.mprop.threading.warnings.types.UnboundMethodType.__call__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__class__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__cmp__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__delattr__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__doc__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__format__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__func__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__get__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__getattribute__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__hash__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__init__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__new__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__reduce__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__reduce_ex__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__repr__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__self__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__setattr__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__sizeof__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__str__
  • modo.mprop.threading.warnings.types.UnboundMethodType.__subclasshook__
  • modo.mprop.threading.warnings.types.UnboundMethodType.im_class
  • modo.mprop.threading.warnings.types.UnboundMethodType.im_func
  • modo.mprop.threading.warnings.types.UnboundMethodType.im_self

modo.mprop.threading.warnings.types.UnboundMethodType.im_class

type: member_descriptor

doc: the class associated with a method

modo.mprop.threading.warnings.types.UnboundMethodType.im_func

type: member_descriptor

doc: the function (or other callable) implementing a method

modo.mprop.threading.warnings.types.UnboundMethodType.im_self

type: member_descriptor

doc: the instance to which a method is bound; None for unbound methods

modo.mprop.threading.warnings.types.UnicodeType

type: type

doc: unicode(string [, encoding[, errors]]) -> object Create a new Unicode object from the given encoded string. encoding defaults to the current default string encoding. errors can be 'strict', 'replace' or 'ignore' and defaults to 'strict'.

modo.mprop.threading.warnings.types.UnicodeType._formatter_field_name_split()

type: method_descriptor

modo.mprop.threading.warnings.types.UnicodeType._formatter_parser()

type: method_descriptor

modo.mprop.threading.warnings.types.UnicodeType.capitalize()

type: method_descriptor

doc: S.capitalize() -> unicode Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

modo.mprop.threading.warnings.types.UnicodeType.center()

type: method_descriptor

doc: S.center(width[, fillchar]) -> unicode Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

modo.mprop.threading.warnings.types.UnicodeType.count()

type: method_descriptor

doc: S.count(sub[, start[, end]]) -> int Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

modo.mprop.threading.warnings.types.UnicodeType.decode()

type: method_descriptor

doc: S.decode([encoding[,errors]]) -> string or unicode Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is 'strict' meaning that encoding errors raise a UnicodeDecodeError. Other possible values are 'ignore' and 'replace' as well as any other name registered with codecs.register_error that is able to handle UnicodeDecodeErrors.

modo.mprop.threading.warnings.types.UnicodeType.encode()

type: method_descriptor

doc: S.encode([encoding[,errors]]) -> string or unicode Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is 'strict' meaning that encoding errors raise a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and 'xmlcharrefreplace' as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

modo.mprop.threading.warnings.types.UnicodeType.endswith()

type: method_descriptor

doc: S.endswith(suffix[, start[, end]]) -> bool Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

modo.mprop.threading.warnings.types.UnicodeType.expandtabs()

type: method_descriptor

doc: S.expandtabs([tabsize]) -> unicode Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

modo.mprop.threading.warnings.types.UnicodeType.find()

type: method_descriptor

doc: S.find(sub [,start [,end]]) -> int Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.

modo.mprop.threading.warnings.types.UnicodeType.format()

type: method_descriptor

doc: S.format(*args, **kwargs) -> unicode Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

modo.mprop.threading.warnings.types.UnicodeType.index()

type: method_descriptor

doc: S.index(sub [,start [,end]]) -> int Like S.find() but raise ValueError when the substring is not found.

modo.mprop.threading.warnings.types.UnicodeType.isalnum()

type: method_descriptor

doc: S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

modo.mprop.threading.warnings.types.UnicodeType.isalpha()

type: method_descriptor

doc: S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

modo.mprop.threading.warnings.types.UnicodeType.isdecimal()

type: method_descriptor

doc: S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

modo.mprop.threading.warnings.types.UnicodeType.isdigit()

type: method_descriptor

doc: S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

modo.mprop.threading.warnings.types.UnicodeType.islower()

type: method_descriptor

doc: S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

modo.mprop.threading.warnings.types.UnicodeType.isnumeric()

type: method_descriptor

doc: S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

modo.mprop.threading.warnings.types.UnicodeType.isspace()

type: method_descriptor

doc: S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

modo.mprop.threading.warnings.types.UnicodeType.istitle()

type: method_descriptor

doc: S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

modo.mprop.threading.warnings.types.UnicodeType.isupper()

type: method_descriptor

doc: S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

modo.mprop.threading.warnings.types.UnicodeType.join()

type: method_descriptor

doc: S.join(iterable) -> unicode Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

modo.mprop.threading.warnings.types.UnicodeType.ljust()

type: method_descriptor

doc: S.ljust(width[, fillchar]) -> int Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

modo.mprop.threading.warnings.types.UnicodeType.lower()

type: method_descriptor

doc: S.lower() -> unicode Return a copy of the string S converted to lowercase.

modo.mprop.threading.warnings.types.UnicodeType.lstrip()

type: method_descriptor

doc: S.lstrip([chars]) -> unicode Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

modo.mprop.threading.warnings.types.UnicodeType.partition()

type: method_descriptor

doc: S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

modo.mprop.threading.warnings.types.UnicodeType.replace()

type: method_descriptor

doc: S.replace(old, new[, count]) -> unicode Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

modo.mprop.threading.warnings.types.UnicodeType.rfind()

type: method_descriptor

doc: S.rfind(sub [,start [,end]]) -> int Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.

modo.mprop.threading.warnings.types.UnicodeType.rindex()

type: method_descriptor

doc: S.rindex(sub [,start [,end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

modo.mprop.threading.warnings.types.UnicodeType.rjust()

type: method_descriptor

doc: S.rjust(width[, fillchar]) -> unicode Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

modo.mprop.threading.warnings.types.UnicodeType.rpartition()

type: method_descriptor

doc: S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

modo.mprop.threading.warnings.types.UnicodeType.rsplit()

type: method_descriptor

doc: S.rsplit([sep [,maxsplit]]) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

modo.mprop.threading.warnings.types.UnicodeType.rstrip()

type: method_descriptor

doc: S.rstrip([chars]) -> unicode Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

modo.mprop.threading.warnings.types.UnicodeType.split()

type: method_descriptor

doc: S.split([sep [,maxsplit]]) -> list of strings Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

modo.mprop.threading.warnings.types.UnicodeType.splitlines()

type: method_descriptor

doc: S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

modo.mprop.threading.warnings.types.UnicodeType.startswith()

type: method_descriptor

doc: S.startswith(prefix[, start[, end]]) -> bool Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

modo.mprop.threading.warnings.types.UnicodeType.strip()

type: method_descriptor

doc: S.strip([chars]) -> unicode Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

modo.mprop.threading.warnings.types.UnicodeType.swapcase()

type: method_descriptor

doc: S.swapcase() -> unicode Return a copy of S with uppercase characters converted to lowercase and vice versa.

modo.mprop.threading.warnings.types.UnicodeType.title()

type: method_descriptor

doc: S.title() -> unicode Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

modo.mprop.threading.warnings.types.UnicodeType.translate()

type: method_descriptor

doc: S.translate(table) -> unicode Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

modo.mprop.threading.warnings.types.UnicodeType.upper()

type: method_descriptor

doc: S.upper() -> unicode Return a copy of S converted to uppercase.

modo.mprop.threading.warnings.types.UnicodeType.zfill()

type: method_descriptor

doc: S.zfill(width) -> unicode Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

modo.mprop.threading.warnings.types.XRangeType

type: type

doc: xrange([start,] stop[, step]) -> xrange object Like range(), but instead of returning a list, returns an object that generates the numbers in the range on demand. For looping, this is slightly faster than range() and more memory efficient.

    modo.mprop.threading.warnings.types.XRangeType contents:
  • modo.mprop.threading.warnings.types.XRangeType.__class__
  • modo.mprop.threading.warnings.types.XRangeType.__delattr__
  • modo.mprop.threading.warnings.types.XRangeType.__doc__
  • modo.mprop.threading.warnings.types.XRangeType.__format__
  • modo.mprop.threading.warnings.types.XRangeType.__getattribute__
  • modo.mprop.threading.warnings.types.XRangeType.__getitem__
  • modo.mprop.threading.warnings.types.XRangeType.__hash__
  • modo.mprop.threading.warnings.types.XRangeType.__init__
  • modo.mprop.threading.warnings.types.XRangeType.__iter__
  • modo.mprop.threading.warnings.types.XRangeType.__len__
  • modo.mprop.threading.warnings.types.XRangeType.__new__
  • modo.mprop.threading.warnings.types.XRangeType.__reduce__
  • modo.mprop.threading.warnings.types.XRangeType.__reduce_ex__
  • modo.mprop.threading.warnings.types.XRangeType.__repr__
  • modo.mprop.threading.warnings.types.XRangeType.__reversed__
  • modo.mprop.threading.warnings.types.XRangeType.__setattr__
  • modo.mprop.threading.warnings.types.XRangeType.__sizeof__
  • modo.mprop.threading.warnings.types.XRangeType.__str__
  • modo.mprop.threading.warnings.types.XRangeType.__subclasshook__

modo.mprop.threading.warnings.warn()

type: builtin_function_or_method

doc: Issue a warning, or maybe ignore it or raise an exception.

modo.mprop.threading.warnings.warn_explicit()

type: builtin_function_or_method

doc: Low-level inferface to warnings functionality.

modo.mprop.threading.warnings.WarningMessage

type: type

doc: Holds the result of a single showwarning() call.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\warnings.pyc

    modo.mprop.threading.warnings.WarningMessage contents:
  • modo.mprop.threading.warnings.WarningMessage.__class__
  • modo.mprop.threading.warnings.WarningMessage.__delattr__
  • modo.mprop.threading.warnings.WarningMessage.__dict__
  • modo.mprop.threading.warnings.WarningMessage.__doc__
  • modo.mprop.threading.warnings.WarningMessage.__format__
  • modo.mprop.threading.warnings.WarningMessage.__getattribute__
  • modo.mprop.threading.warnings.WarningMessage.__hash__
  • modo.mprop.threading.warnings.WarningMessage.__init__
  • modo.mprop.threading.warnings.WarningMessage.__module__
  • modo.mprop.threading.warnings.WarningMessage.__new__
  • modo.mprop.threading.warnings.WarningMessage.__reduce__
  • modo.mprop.threading.warnings.WarningMessage.__reduce_ex__
  • modo.mprop.threading.warnings.WarningMessage.__repr__
  • modo.mprop.threading.warnings.WarningMessage.__setattr__
  • modo.mprop.threading.warnings.WarningMessage.__sizeof__
  • modo.mprop.threading.warnings.WarningMessage.__str__
  • modo.mprop.threading.warnings.WarningMessage.__subclasshook__
  • modo.mprop.threading.warnings.WarningMessage.__weakref__
  • modo.mprop.threading.warnings.WarningMessage._WARNING_DETAILS

modo.mprop.threading.warnings.WarningMessage._WARNING_DETAILS

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.threading.warnings.warnpy3k

type: function

doc: Issue a deprecation warning for Python 3.x related changes. Warnings are omitted unless Python is started with the -3 option.

file: u:\Luxology\source\extra\python\python2.7\lib\warnings.py

modo.mprop.types

type: module

doc: Define names for all type symbols known in the standard interpreter. Types that are part of optional modules (e.g. array) are not listed.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\types.pyc

modo.mprop.types.BooleanType

type: type

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

    modo.mprop.types.BooleanType contents:
  • modo.mprop.types.BooleanType.__abs__
  • modo.mprop.types.BooleanType.__add__
  • modo.mprop.types.BooleanType.__and__
  • modo.mprop.types.BooleanType.__class__
  • modo.mprop.types.BooleanType.__cmp__
  • modo.mprop.types.BooleanType.__coerce__
  • modo.mprop.types.BooleanType.__delattr__
  • modo.mprop.types.BooleanType.__div__
  • modo.mprop.types.BooleanType.__divmod__
  • modo.mprop.types.BooleanType.__doc__
  • modo.mprop.types.BooleanType.__float__
  • modo.mprop.types.BooleanType.__floordiv__
  • modo.mprop.types.BooleanType.__format__
  • modo.mprop.types.BooleanType.__getattribute__
  • modo.mprop.types.BooleanType.__getnewargs__
  • modo.mprop.types.BooleanType.__hash__
  • modo.mprop.types.BooleanType.__hex__
  • modo.mprop.types.BooleanType.__index__
  • modo.mprop.types.BooleanType.__init__
  • modo.mprop.types.BooleanType.__int__
  • modo.mprop.types.BooleanType.__invert__
  • modo.mprop.types.BooleanType.__long__
  • modo.mprop.types.BooleanType.__lshift__
  • modo.mprop.types.BooleanType.__mod__
  • modo.mprop.types.BooleanType.__mul__
  • modo.mprop.types.BooleanType.__neg__
  • modo.mprop.types.BooleanType.__new__
  • modo.mprop.types.BooleanType.__nonzero__
  • modo.mprop.types.BooleanType.__oct__
  • modo.mprop.types.BooleanType.__or__
  • modo.mprop.types.BooleanType.__pos__
  • modo.mprop.types.BooleanType.__pow__
  • modo.mprop.types.BooleanType.__radd__
  • modo.mprop.types.BooleanType.__rand__
  • modo.mprop.types.BooleanType.__rdiv__
  • modo.mprop.types.BooleanType.__rdivmod__
  • modo.mprop.types.BooleanType.__reduce__
  • modo.mprop.types.BooleanType.__reduce_ex__
  • modo.mprop.types.BooleanType.__repr__
  • modo.mprop.types.BooleanType.__rfloordiv__
  • modo.mprop.types.BooleanType.__rlshift__
  • modo.mprop.types.BooleanType.__rmod__
  • modo.mprop.types.BooleanType.__rmul__
  • modo.mprop.types.BooleanType.__ror__
  • modo.mprop.types.BooleanType.__rpow__
  • modo.mprop.types.BooleanType.__rrshift__
  • modo.mprop.types.BooleanType.__rshift__
  • modo.mprop.types.BooleanType.__rsub__
  • modo.mprop.types.BooleanType.__rtruediv__
  • modo.mprop.types.BooleanType.__rxor__
  • modo.mprop.types.BooleanType.__setattr__
  • modo.mprop.types.BooleanType.__sizeof__
  • modo.mprop.types.BooleanType.__str__
  • modo.mprop.types.BooleanType.__sub__
  • modo.mprop.types.BooleanType.__subclasshook__
  • modo.mprop.types.BooleanType.__truediv__
  • modo.mprop.types.BooleanType.__trunc__
  • modo.mprop.types.BooleanType.__xor__
  • modo.mprop.types.BooleanType.bit_length
  • modo.mprop.types.BooleanType.conjugate
  • modo.mprop.types.BooleanType.denominator
  • modo.mprop.types.BooleanType.imag
  • modo.mprop.types.BooleanType.numerator
  • modo.mprop.types.BooleanType.real

modo.mprop.types.BooleanType.bit_length()

type: method_descriptor

doc: int.bit_length() -> int Number of bits necessary to represent self in binary. >>> bin(37) '0b100101' >>> (37).bit_length() 6

modo.mprop.types.BooleanType.conjugate()

type: method_descriptor

doc: Returns self, the complex conjugate of any int.

modo.mprop.types.BooleanType.denominator

type: getset_descriptor

doc: the denominator of a rational number in lowest terms

modo.mprop.types.BooleanType.imag

type: getset_descriptor

doc: the imaginary part of a complex number

modo.mprop.types.BooleanType.numerator

type: getset_descriptor

doc: the numerator of a rational number in lowest terms

modo.mprop.types.BooleanType.real

type: getset_descriptor

doc: the real part of a complex number

modo.mprop.types.BufferType

type: type

doc: buffer(object [, offset[, size]]) Create a new buffer object which references the given object. The buffer will reference a slice of the target object from the start of the object (or at the specified offset). The slice will extend to the end of the target object (or with the specified size).

    modo.mprop.types.BufferType contents:
  • modo.mprop.types.BufferType.__add__
  • modo.mprop.types.BufferType.__class__
  • modo.mprop.types.BufferType.__cmp__
  • modo.mprop.types.BufferType.__delattr__
  • modo.mprop.types.BufferType.__delitem__
  • modo.mprop.types.BufferType.__delslice__
  • modo.mprop.types.BufferType.__doc__
  • modo.mprop.types.BufferType.__format__
  • modo.mprop.types.BufferType.__getattribute__
  • modo.mprop.types.BufferType.__getitem__
  • modo.mprop.types.BufferType.__getslice__
  • modo.mprop.types.BufferType.__hash__
  • modo.mprop.types.BufferType.__init__
  • modo.mprop.types.BufferType.__len__
  • modo.mprop.types.BufferType.__mul__
  • modo.mprop.types.BufferType.__new__
  • modo.mprop.types.BufferType.__reduce__
  • modo.mprop.types.BufferType.__reduce_ex__
  • modo.mprop.types.BufferType.__repr__
  • modo.mprop.types.BufferType.__rmul__
  • modo.mprop.types.BufferType.__setattr__
  • modo.mprop.types.BufferType.__setitem__
  • modo.mprop.types.BufferType.__setslice__
  • modo.mprop.types.BufferType.__sizeof__
  • modo.mprop.types.BufferType.__str__
  • modo.mprop.types.BufferType.__subclasshook__
modo.mprop.types.BuiltinFunctionType

type: type

    modo.mprop.types.BuiltinFunctionType contents:
  • modo.mprop.types.BuiltinFunctionType.__call__
  • modo.mprop.types.BuiltinFunctionType.__class__
  • modo.mprop.types.BuiltinFunctionType.__cmp__
  • modo.mprop.types.BuiltinFunctionType.__delattr__
  • modo.mprop.types.BuiltinFunctionType.__doc__
  • modo.mprop.types.BuiltinFunctionType.__eq__
  • modo.mprop.types.BuiltinFunctionType.__format__
  • modo.mprop.types.BuiltinFunctionType.__ge__
  • modo.mprop.types.BuiltinFunctionType.__getattribute__
  • modo.mprop.types.BuiltinFunctionType.__gt__
  • modo.mprop.types.BuiltinFunctionType.__hash__
  • modo.mprop.types.BuiltinFunctionType.__init__
  • modo.mprop.types.BuiltinFunctionType.__le__
  • modo.mprop.types.BuiltinFunctionType.__lt__
  • modo.mprop.types.BuiltinFunctionType.__module__
  • modo.mprop.types.BuiltinFunctionType.__name__
  • modo.mprop.types.BuiltinFunctionType.__ne__
  • modo.mprop.types.BuiltinFunctionType.__new__
  • modo.mprop.types.BuiltinFunctionType.__reduce__
  • modo.mprop.types.BuiltinFunctionType.__reduce_ex__
  • modo.mprop.types.BuiltinFunctionType.__repr__
  • modo.mprop.types.BuiltinFunctionType.__self__
  • modo.mprop.types.BuiltinFunctionType.__setattr__
  • modo.mprop.types.BuiltinFunctionType.__sizeof__
  • modo.mprop.types.BuiltinFunctionType.__str__
  • modo.mprop.types.BuiltinFunctionType.__subclasshook__
modo.mprop.types.BuiltinMethodType

type: type

    modo.mprop.types.BuiltinMethodType contents:
  • modo.mprop.types.BuiltinMethodType.__call__
  • modo.mprop.types.BuiltinMethodType.__class__
  • modo.mprop.types.BuiltinMethodType.__cmp__
  • modo.mprop.types.BuiltinMethodType.__delattr__
  • modo.mprop.types.BuiltinMethodType.__doc__
  • modo.mprop.types.BuiltinMethodType.__eq__
  • modo.mprop.types.BuiltinMethodType.__format__
  • modo.mprop.types.BuiltinMethodType.__ge__
  • modo.mprop.types.BuiltinMethodType.__getattribute__
  • modo.mprop.types.BuiltinMethodType.__gt__
  • modo.mprop.types.BuiltinMethodType.__hash__
  • modo.mprop.types.BuiltinMethodType.__init__
  • modo.mprop.types.BuiltinMethodType.__le__
  • modo.mprop.types.BuiltinMethodType.__lt__
  • modo.mprop.types.BuiltinMethodType.__module__
  • modo.mprop.types.BuiltinMethodType.__name__
  • modo.mprop.types.BuiltinMethodType.__ne__
  • modo.mprop.types.BuiltinMethodType.__new__
  • modo.mprop.types.BuiltinMethodType.__reduce__
  • modo.mprop.types.BuiltinMethodType.__reduce_ex__
  • modo.mprop.types.BuiltinMethodType.__repr__
  • modo.mprop.types.BuiltinMethodType.__self__
  • modo.mprop.types.BuiltinMethodType.__setattr__
  • modo.mprop.types.BuiltinMethodType.__sizeof__
  • modo.mprop.types.BuiltinMethodType.__str__
  • modo.mprop.types.BuiltinMethodType.__subclasshook__
modo.mprop.types.ClassType

type: type

doc: classobj(name, bases, dict) Create a class object. The name must be a string; the second argument a tuple of classes, and the third a dictionary.

    modo.mprop.types.ClassType contents:
  • modo.mprop.types.ClassType.__call__
  • modo.mprop.types.ClassType.__class__
  • modo.mprop.types.ClassType.__delattr__
  • modo.mprop.types.ClassType.__doc__
  • modo.mprop.types.ClassType.__format__
  • modo.mprop.types.ClassType.__getattribute__
  • modo.mprop.types.ClassType.__hash__
  • modo.mprop.types.ClassType.__init__
  • modo.mprop.types.ClassType.__new__
  • modo.mprop.types.ClassType.__reduce__
  • modo.mprop.types.ClassType.__reduce_ex__
  • modo.mprop.types.ClassType.__repr__
  • modo.mprop.types.ClassType.__setattr__
  • modo.mprop.types.ClassType.__sizeof__
  • modo.mprop.types.ClassType.__str__
  • modo.mprop.types.ClassType.__subclasshook__
modo.mprop.types.CodeType

type: type

doc: code(argcount, nlocals, stacksize, flags, codestring, constants, names, varnames, filename, name, firstlineno, lnotab[, freevars[, cellvars]]) Create a code object. Not for the faint of heart.

modo.mprop.types.CodeType.co_argcount

type: member_descriptor

modo.mprop.types.CodeType.co_cellvars

type: member_descriptor

modo.mprop.types.CodeType.co_code

type: member_descriptor

modo.mprop.types.CodeType.co_consts

type: member_descriptor

modo.mprop.types.CodeType.co_filename

type: member_descriptor

modo.mprop.types.CodeType.co_firstlineno

type: member_descriptor

modo.mprop.types.CodeType.co_flags

type: member_descriptor

modo.mprop.types.CodeType.co_freevars

type: member_descriptor

modo.mprop.types.CodeType.co_lnotab

type: member_descriptor

modo.mprop.types.CodeType.co_name

type: member_descriptor

modo.mprop.types.CodeType.co_names

type: member_descriptor

modo.mprop.types.CodeType.co_nlocals

type: member_descriptor

modo.mprop.types.CodeType.co_stacksize

type: member_descriptor

modo.mprop.types.CodeType.co_varnames

type: member_descriptor

modo.mprop.types.ComplexType

type: type

doc: complex(real[, imag]) -> complex number Create a complex number from a real part and an optional imaginary part. This is equivalent to (real + imag*1j) where imag defaults to 0.

    modo.mprop.types.ComplexType contents:
  • modo.mprop.types.ComplexType.__abs__
  • modo.mprop.types.ComplexType.__add__
  • modo.mprop.types.ComplexType.__class__
  • modo.mprop.types.ComplexType.__coerce__
  • modo.mprop.types.ComplexType.__delattr__
  • modo.mprop.types.ComplexType.__div__
  • modo.mprop.types.ComplexType.__divmod__
  • modo.mprop.types.ComplexType.__doc__
  • modo.mprop.types.ComplexType.__eq__
  • modo.mprop.types.ComplexType.__float__
  • modo.mprop.types.ComplexType.__floordiv__
  • modo.mprop.types.ComplexType.__format__
  • modo.mprop.types.ComplexType.__ge__
  • modo.mprop.types.ComplexType.__getattribute__
  • modo.mprop.types.ComplexType.__getnewargs__
  • modo.mprop.types.ComplexType.__gt__
  • modo.mprop.types.ComplexType.__hash__
  • modo.mprop.types.ComplexType.__init__
  • modo.mprop.types.ComplexType.__int__
  • modo.mprop.types.ComplexType.__le__
  • modo.mprop.types.ComplexType.__long__
  • modo.mprop.types.ComplexType.__lt__
  • modo.mprop.types.ComplexType.__mod__
  • modo.mprop.types.ComplexType.__mul__
  • modo.mprop.types.ComplexType.__ne__
  • modo.mprop.types.ComplexType.__neg__
  • modo.mprop.types.ComplexType.__new__
  • modo.mprop.types.ComplexType.__nonzero__
  • modo.mprop.types.ComplexType.__pos__
  • modo.mprop.types.ComplexType.__pow__
  • modo.mprop.types.ComplexType.__radd__
  • modo.mprop.types.ComplexType.__rdiv__
  • modo.mprop.types.ComplexType.__rdivmod__
  • modo.mprop.types.ComplexType.__reduce__
  • modo.mprop.types.ComplexType.__reduce_ex__
  • modo.mprop.types.ComplexType.__repr__
  • modo.mprop.types.ComplexType.__rfloordiv__
  • modo.mprop.types.ComplexType.__rmod__
  • modo.mprop.types.ComplexType.__rmul__
  • modo.mprop.types.ComplexType.__rpow__
  • modo.mprop.types.ComplexType.__rsub__
  • modo.mprop.types.ComplexType.__rtruediv__
  • modo.mprop.types.ComplexType.__setattr__
  • modo.mprop.types.ComplexType.__sizeof__
  • modo.mprop.types.ComplexType.__str__
  • modo.mprop.types.ComplexType.__sub__
  • modo.mprop.types.ComplexType.__subclasshook__
  • modo.mprop.types.ComplexType.__truediv__
  • modo.mprop.types.ComplexType.conjugate
  • modo.mprop.types.ComplexType.imag
  • modo.mprop.types.ComplexType.real

modo.mprop.types.ComplexType.conjugate()

type: method_descriptor

doc: complex.conjugate() -> complex Returns the complex conjugate of its argument. (3-4j).conjugate() == 3+4j.

modo.mprop.types.ComplexType.imag

type: member_descriptor

doc: the imaginary part of a complex number

modo.mprop.types.ComplexType.real

type: member_descriptor

doc: the real part of a complex number

modo.mprop.types.DictionaryType

type: type

doc: dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

modo.mprop.types.DictionaryType.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.mprop.types.DictionaryType.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D

modo.mprop.types.DictionaryType.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.types.DictionaryType.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.types.DictionaryType.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.types.DictionaryType.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.types.DictionaryType.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.types.DictionaryType.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.types.DictionaryType.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.types.DictionaryType.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.mprop.types.DictionaryType.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.types.DictionaryType.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.types.DictionaryType.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.types.DictionaryType.update()

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.types.DictionaryType.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.mprop.types.DictionaryType.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.types.DictionaryType.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.types.DictionaryType.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.types.DictProxyType

type: type

modo.mprop.types.DictProxyType.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D

modo.mprop.types.DictProxyType.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if D.has_key(k), else d. d defaults to None.

modo.mprop.types.DictProxyType.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.types.DictProxyType.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.types.DictProxyType.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.types.DictProxyType.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.types.DictProxyType.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.types.DictProxyType.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.mprop.types.DictProxyType.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.mprop.types.DictType

type: type

doc: dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object's (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

modo.mprop.types.DictType.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.mprop.types.DictType.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D

modo.mprop.types.DictType.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.mprop.types.DictType.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.mprop.types.DictType.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.mprop.types.DictType.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.mprop.types.DictType.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.mprop.types.DictType.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.mprop.types.DictType.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.mprop.types.DictType.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.mprop.types.DictType.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.mprop.types.DictType.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.mprop.types.DictType.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.mprop.types.DictType.update()

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.mprop.types.DictType.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.mprop.types.DictType.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.mprop.types.DictType.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.mprop.types.DictType.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.mprop.types.EllipsisType

type: type

    modo.mprop.types.EllipsisType contents:
  • modo.mprop.types.EllipsisType.__class__
  • modo.mprop.types.EllipsisType.__delattr__
  • modo.mprop.types.EllipsisType.__doc__
  • modo.mprop.types.EllipsisType.__format__
  • modo.mprop.types.EllipsisType.__getattribute__
  • modo.mprop.types.EllipsisType.__hash__
  • modo.mprop.types.EllipsisType.__init__
  • modo.mprop.types.EllipsisType.__new__
  • modo.mprop.types.EllipsisType.__reduce__
  • modo.mprop.types.EllipsisType.__reduce_ex__
  • modo.mprop.types.EllipsisType.__repr__
  • modo.mprop.types.EllipsisType.__setattr__
  • modo.mprop.types.EllipsisType.__sizeof__
  • modo.mprop.types.EllipsisType.__str__
  • modo.mprop.types.EllipsisType.__subclasshook__
modo.mprop.types.FileType

type: type

doc: file(name[, mode[, buffering]]) -> file object Open a file. The mode can be 'r', 'w' or 'a' for reading (default), writing or appending. The file will be created if it doesn't exist when opened for writing or appending; it will be truncated when opened for writing. Add a 'b' to the mode for binary files. Add a '+' to the mode to allow simultaneous reading and writing. If the buffering argument is given, 0 means unbuffered, 1 means line buffered, and larger numbers specify the buffer size. The preferred way to open a file is with the builtin open() function. Add a 'U' to mode to open the file for input with universal newline support. Any line ending in the input file will be seen as a '\n' in Python. Also, a file so opened gains the attribute 'newlines'; the value for this attribute is one of None (no newline read yet), '\r', '\n', '\r\n' or a tuple containing all the newline types seen. 'U' cannot be combined with 'w' or '+' mode.

modo.mprop.types.FileType.close()

type: method_descriptor

doc: close() -> None or (perhaps) an integer. Close the file. Sets data attribute .closed to True. A closed file cannot be used for further I/O operations. close() may be called more than once without error. Some kinds of file objects (for example, opened by popen()) may return an exit status upon closing.

modo.mprop.types.FileType.closed

type: getset_descriptor

doc: True if the file is closed

modo.mprop.types.FileType.encoding

type: member_descriptor

doc: file encoding

modo.mprop.types.FileType.errors

type: member_descriptor

doc: Unicode error handler

modo.mprop.types.FileType.fileno()

type: method_descriptor

doc: fileno() -> integer "file descriptor". This is needed for lower-level file interfaces, such os.read().

modo.mprop.types.FileType.flush()

type: method_descriptor

doc: flush() -> None. Flush the internal I/O buffer.

modo.mprop.types.FileType.isatty()

type: method_descriptor

doc: isatty() -> true or false. True if the file is connected to a tty device.

modo.mprop.types.FileType.mode

type: member_descriptor

doc: file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)

modo.mprop.types.FileType.name

type: member_descriptor

doc: file name

modo.mprop.types.FileType.newlines

type: getset_descriptor

doc: end-of-line convention used in this file

modo.mprop.types.FileType.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.mprop.types.FileType.read()

type: method_descriptor

doc: read([size]) -> read at most size bytes, returned as a string. If the size argument is negative or omitted, read until EOF is reached. Notice that when in non-blocking mode, less data than what was requested may be returned, even if no size parameter was given.

modo.mprop.types.FileType.readinto()

type: method_descriptor

doc: readinto() -> Undocumented. Don't use this; it may go away.

modo.mprop.types.FileType.readline()

type: method_descriptor

doc: readline([size]) -> next line from the file, as a string. Retain newline. A non-negative size argument limits the maximum number of bytes to return (an incomplete line may be returned then). Return an empty string at EOF.

modo.mprop.types.FileType.readlines()

type: method_descriptor

doc: readlines([size]) -> list of strings, each a line from the file. Call readline() repeatedly and return a list of the lines so read. The optional size argument, if given, is an approximate bound on the total number of bytes in the lines returned.

modo.mprop.types.FileType.seek()

type: method_descriptor

doc: seek(offset[, whence]) -> None. Move to new file position. Argument offset is a byte count. Optional argument whence defaults to 0 (offset from start of file, offset should be >= 0); other values are 1 (move relative to current position, positive or negative), and 2 (move relative to end of file, usually negative, although many platforms allow seeking beyond the end of a file). If the file is opened in text mode, only offsets returned by tell() are legal. Use of other offsets causes undefined behavior. Note that not all file objects are seekable.

modo.mprop.types.FileType.softspace

type: getset_descriptor

doc: flag indicating that a space needs to be printed; used by print

modo.mprop.types.FileType.tell()

type: method_descriptor

doc: tell() -> current file position, an integer (may be a long integer).

modo.mprop.types.FileType.truncate()

type: method_descriptor

doc: truncate([size]) -> None. Truncate the file to at most size bytes. Size defaults to the current file position, as returned by tell().

modo.mprop.types.FileType.write()

type: method_descriptor

doc: write(str) -> None. Write string str to file. Note that due to buffering, flush() or close() may be needed before the file on disk reflects the data written.

modo.mprop.types.FileType.writelines()

type: method_descriptor

doc: writelines(sequence_of_strings) -> None. Write the strings to the file. Note that newlines are not added. The sequence can be any iterable object producing strings. This is equivalent to calling write() for each string.

modo.mprop.types.FileType.xreadlines()

type: method_descriptor

doc: xreadlines() -> returns self. For backward compatibility. File objects now include the performance optimizations previously implemented in the xreadlines module.

modo.mprop.types.FloatType

type: type

doc: float(x) -> floating point number Convert a string or number to a floating point number, if possible.

    modo.mprop.types.FloatType contents:
  • modo.mprop.types.FloatType.__abs__
  • modo.mprop.types.FloatType.__add__
  • modo.mprop.types.FloatType.__class__
  • modo.mprop.types.FloatType.__coerce__
  • modo.mprop.types.FloatType.__delattr__
  • modo.mprop.types.FloatType.__div__
  • modo.mprop.types.FloatType.__divmod__
  • modo.mprop.types.FloatType.__doc__
  • modo.mprop.types.FloatType.__eq__
  • modo.mprop.types.FloatType.__float__
  • modo.mprop.types.FloatType.__floordiv__
  • modo.mprop.types.FloatType.__format__
  • modo.mprop.types.FloatType.__ge__
  • modo.mprop.types.FloatType.__getattribute__
  • modo.mprop.types.FloatType.__getformat__
  • modo.mprop.types.FloatType.__getnewargs__
  • modo.mprop.types.FloatType.__gt__
  • modo.mprop.types.FloatType.__hash__
  • modo.mprop.types.FloatType.__init__
  • modo.mprop.types.FloatType.__int__
  • modo.mprop.types.FloatType.__le__
  • modo.mprop.types.FloatType.__long__
  • modo.mprop.types.FloatType.__lt__
  • modo.mprop.types.FloatType.__mod__
  • modo.mprop.types.FloatType.__mul__
  • modo.mprop.types.FloatType.__ne__
  • modo.mprop.types.FloatType.__neg__
  • modo.mprop.types.FloatType.__new__
  • modo.mprop.types.FloatType.__nonzero__
  • modo.mprop.types.FloatType.__pos__
  • modo.mprop.types.FloatType.__pow__
  • modo.mprop.types.FloatType.__radd__
  • modo.mprop.types.FloatType.__rdiv__
  • modo.mprop.types.FloatType.__rdivmod__
  • modo.mprop.types.FloatType.__reduce__
  • modo.mprop.types.FloatType.__reduce_ex__
  • modo.mprop.types.FloatType.__repr__
  • modo.mprop.types.FloatType.__rfloordiv__
  • modo.mprop.types.FloatType.__rmod__
  • modo.mprop.types.FloatType.__rmul__
  • modo.mprop.types.FloatType.__rpow__
  • modo.mprop.types.FloatType.__rsub__
  • modo.mprop.types.FloatType.__rtruediv__
  • modo.mprop.types.FloatType.__setattr__
  • modo.mprop.types.FloatType.__setformat__
  • modo.mprop.types.FloatType.__sizeof__
  • modo.mprop.types.FloatType.__str__
  • modo.mprop.types.FloatType.__sub__
  • modo.mprop.types.FloatType.__subclasshook__
  • modo.mprop.types.FloatType.__truediv__
  • modo.mprop.types.FloatType.__trunc__
  • modo.mprop.types.FloatType.as_integer_ratio
  • modo.mprop.types.FloatType.conjugate
  • modo.mprop.types.FloatType.fromhex
  • modo.mprop.types.FloatType.hex
  • modo.mprop.types.FloatType.imag
  • modo.mprop.types.FloatType.is_integer
  • modo.mprop.types.FloatType.real

modo.mprop.types.FloatType.as_integer_ratio()

type: method_descriptor

doc: float.as_integer_ratio() -> (int, int) Returns a pair of integers, whose ratio is exactly equal to the original float and with a positive denominator. Raises OverflowError on infinities and a ValueError on NaNs. >>> (10.0).as_integer_ratio() (10, 1) >>> (0.0).as_integer_ratio() (0, 1) >>> (-.25).as_integer_ratio() (-1, 4)

modo.mprop.types.FloatType.conjugate()

type: method_descriptor

doc: Returns self, the complex conjugate of any float.

modo.mprop.types.FloatType.fromhex()

type: builtin_function_or_method

doc: float.fromhex(string) -> float Create a floating-point number from a hexadecimal string. >>> float.fromhex('0x1.ffffp10') 2047.984375 >>> float.fromhex('-0x1p-1074') -4.9406564584124654e-324

modo.mprop.types.FloatType.hex()

type: method_descriptor

doc: float.hex() -> string Return a hexadecimal representation of a floating-point number. >>> (-0.1).hex() '-0x1.999999999999ap-4' >>> 3.14159.hex() '0x1.921f9f01b866ep+1'

modo.mprop.types.FloatType.imag

type: getset_descriptor

doc: the imaginary part of a complex number

modo.mprop.types.FloatType.is_integer()

type: method_descriptor

doc: Returns True if the float is an integer.

modo.mprop.types.FloatType.real

type: getset_descriptor

doc: the real part of a complex number

modo.mprop.types.FrameType

type: type

modo.mprop.types.FrameType.f_back

type: member_descriptor

modo.mprop.types.FrameType.f_builtins

type: member_descriptor

modo.mprop.types.FrameType.f_code

type: member_descriptor

modo.mprop.types.FrameType.f_exc_traceback

type: getset_descriptor

modo.mprop.types.FrameType.f_exc_type

type: getset_descriptor

modo.mprop.types.FrameType.f_exc_value

type: getset_descriptor

modo.mprop.types.FrameType.f_globals

type: member_descriptor

modo.mprop.types.FrameType.f_lasti

type: member_descriptor

modo.mprop.types.FrameType.f_lineno

type: getset_descriptor

modo.mprop.types.FrameType.f_locals

type: getset_descriptor

modo.mprop.types.FrameType.f_restricted

type: getset_descriptor

modo.mprop.types.FrameType.f_trace

type: getset_descriptor

modo.mprop.types.FunctionType

type: type

doc: function(code, globals[, name[, argdefs[, closure]]]) Create a function object from a code object and a dictionary. The optional name string overrides the name from the code object. The optional argdefs tuple specifies the default argument values. The optional closure tuple supplies the bindings for free variables.

modo.mprop.types.FunctionType.func_closure

type: member_descriptor

modo.mprop.types.FunctionType.func_code

type: getset_descriptor

modo.mprop.types.FunctionType.func_defaults

type: getset_descriptor

modo.mprop.types.FunctionType.func_dict

type: getset_descriptor

modo.mprop.types.FunctionType.func_doc

type: member_descriptor

modo.mprop.types.FunctionType.func_globals

type: member_descriptor

modo.mprop.types.FunctionType.func_name

type: getset_descriptor

modo.mprop.types.GeneratorType

type: type

modo.mprop.types.GeneratorType.close()

type: method_descriptor

doc: close(arg) -> raise GeneratorExit inside generator.

modo.mprop.types.GeneratorType.gi_code

type: member_descriptor

modo.mprop.types.GeneratorType.gi_frame

type: member_descriptor

modo.mprop.types.GeneratorType.gi_running

type: member_descriptor

modo.mprop.types.GeneratorType.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.mprop.types.GeneratorType.send()

type: method_descriptor

doc: send(arg) -> send 'arg' into generator, return next yielded value or raise StopIteration.

modo.mprop.types.GeneratorType.throw()

type: method_descriptor

doc: throw(typ[,val[,tb]]) -> raise exception in generator, return next yielded value or raise StopIteration.

modo.mprop.types.GetSetDescriptorType

type: type

    modo.mprop.types.GetSetDescriptorType contents:
  • modo.mprop.types.GetSetDescriptorType.__class__
  • modo.mprop.types.GetSetDescriptorType.__delattr__
  • modo.mprop.types.GetSetDescriptorType.__delete__
  • modo.mprop.types.GetSetDescriptorType.__doc__
  • modo.mprop.types.GetSetDescriptorType.__format__
  • modo.mprop.types.GetSetDescriptorType.__get__
  • modo.mprop.types.GetSetDescriptorType.__getattribute__
  • modo.mprop.types.GetSetDescriptorType.__hash__
  • modo.mprop.types.GetSetDescriptorType.__init__
  • modo.mprop.types.GetSetDescriptorType.__name__
  • modo.mprop.types.GetSetDescriptorType.__new__
  • modo.mprop.types.GetSetDescriptorType.__objclass__
  • modo.mprop.types.GetSetDescriptorType.__reduce__
  • modo.mprop.types.GetSetDescriptorType.__reduce_ex__
  • modo.mprop.types.GetSetDescriptorType.__repr__
  • modo.mprop.types.GetSetDescriptorType.__set__
  • modo.mprop.types.GetSetDescriptorType.__setattr__
  • modo.mprop.types.GetSetDescriptorType.__sizeof__
  • modo.mprop.types.GetSetDescriptorType.__str__
  • modo.mprop.types.GetSetDescriptorType.__subclasshook__
modo.mprop.types.InstanceType

type: type

doc: instance(class[, dict]) Create an instance without calling its __init__() method. The class must be a classic class. If present, dict must be a dictionary or None.

    modo.mprop.types.InstanceType contents:
  • modo.mprop.types.InstanceType.__abs__
  • modo.mprop.types.InstanceType.__add__
  • modo.mprop.types.InstanceType.__and__
  • modo.mprop.types.InstanceType.__call__
  • modo.mprop.types.InstanceType.__class__
  • modo.mprop.types.InstanceType.__cmp__
  • modo.mprop.types.InstanceType.__coerce__
  • modo.mprop.types.InstanceType.__contains__
  • modo.mprop.types.InstanceType.__delattr__
  • modo.mprop.types.InstanceType.__delitem__
  • modo.mprop.types.InstanceType.__delslice__
  • modo.mprop.types.InstanceType.__div__
  • modo.mprop.types.InstanceType.__divmod__
  • modo.mprop.types.InstanceType.__doc__
  • modo.mprop.types.InstanceType.__eq__
  • modo.mprop.types.InstanceType.__float__
  • modo.mprop.types.InstanceType.__floordiv__
  • modo.mprop.types.InstanceType.__format__
  • modo.mprop.types.InstanceType.__ge__
  • modo.mprop.types.InstanceType.__getattribute__
  • modo.mprop.types.InstanceType.__getitem__
  • modo.mprop.types.InstanceType.__getslice__
  • modo.mprop.types.InstanceType.__gt__
  • modo.mprop.types.InstanceType.__hash__
  • modo.mprop.types.InstanceType.__hex__
  • modo.mprop.types.InstanceType.__iadd__
  • modo.mprop.types.InstanceType.__iand__
  • modo.mprop.types.InstanceType.__idiv__
  • modo.mprop.types.InstanceType.__ifloordiv__
  • modo.mprop.types.InstanceType.__ilshift__
  • modo.mprop.types.InstanceType.__imod__
  • modo.mprop.types.InstanceType.__imul__
  • modo.mprop.types.InstanceType.__index__
  • modo.mprop.types.InstanceType.__init__
  • modo.mprop.types.InstanceType.__int__
  • modo.mprop.types.InstanceType.__invert__
  • modo.mprop.types.InstanceType.__ior__
  • modo.mprop.types.InstanceType.__ipow__
  • modo.mprop.types.InstanceType.__irshift__
  • modo.mprop.types.InstanceType.__isub__
  • modo.mprop.types.InstanceType.__iter__
  • modo.mprop.types.InstanceType.__itruediv__
  • modo.mprop.types.InstanceType.__ixor__
  • modo.mprop.types.InstanceType.__le__
  • modo.mprop.types.InstanceType.__len__
  • modo.mprop.types.InstanceType.__long__
  • modo.mprop.types.InstanceType.__lshift__
  • modo.mprop.types.InstanceType.__lt__
  • modo.mprop.types.InstanceType.__mod__
  • modo.mprop.types.InstanceType.__mul__
  • modo.mprop.types.InstanceType.__ne__
  • modo.mprop.types.InstanceType.__neg__
  • modo.mprop.types.InstanceType.__new__
  • modo.mprop.types.InstanceType.__nonzero__
  • modo.mprop.types.InstanceType.__oct__
  • modo.mprop.types.InstanceType.__or__
  • modo.mprop.types.InstanceType.__pos__
  • modo.mprop.types.InstanceType.__pow__
  • modo.mprop.types.InstanceType.__radd__
  • modo.mprop.types.InstanceType.__rand__
  • modo.mprop.types.InstanceType.__rdiv__
  • modo.mprop.types.InstanceType.__rdivmod__
  • modo.mprop.types.InstanceType.__reduce__
  • modo.mprop.types.InstanceType.__reduce_ex__
  • modo.mprop.types.InstanceType.__repr__
  • modo.mprop.types.InstanceType.__rfloordiv__
  • modo.mprop.types.InstanceType.__rlshift__
  • modo.mprop.types.InstanceType.__rmod__
  • modo.mprop.types.InstanceType.__rmul__
  • modo.mprop.types.InstanceType.__ror__
  • modo.mprop.types.InstanceType.__rpow__
  • modo.mprop.types.InstanceType.__rrshift__
  • modo.mprop.types.InstanceType.__rshift__
  • modo.mprop.types.InstanceType.__rsub__
  • modo.mprop.types.InstanceType.__rtruediv__
  • modo.mprop.types.InstanceType.__rxor__
  • modo.mprop.types.InstanceType.__setattr__
  • modo.mprop.types.InstanceType.__setitem__
  • modo.mprop.types.InstanceType.__setslice__
  • modo.mprop.types.InstanceType.__sizeof__
  • modo.mprop.types.InstanceType.__str__
  • modo.mprop.types.InstanceType.__sub__
  • modo.mprop.types.InstanceType.__subclasshook__
  • modo.mprop.types.InstanceType.__truediv__
  • modo.mprop.types.InstanceType.__xor__
  • modo.mprop.types.InstanceType.next

modo.mprop.types.InstanceType.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.mprop.types.IntType

type: type

doc: int(x[, base]) -> integer Convert a string or number to an integer, if possible. A floating point argument will be truncated towards zero (this does not include a string representation of a floating point number!) When converting a string, use the optional base. It is an error to supply a base when converting a non-string. If base is zero, the proper base is guessed based on the string content. If the argument is outside the integer range a long object will be returned instead.

    modo.mprop.types.IntType contents:
  • modo.mprop.types.IntType.__abs__
  • modo.mprop.types.IntType.__add__
  • modo.mprop.types.IntType.__and__
  • modo.mprop.types.IntType.__class__
  • modo.mprop.types.IntType.__cmp__
  • modo.mprop.types.IntType.__coerce__
  • modo.mprop.types.IntType.__delattr__
  • modo.mprop.types.IntType.__div__
  • modo.mprop.types.IntType.__divmod__
  • modo.mprop.types.IntType.__doc__
  • modo.mprop.types.IntType.__float__
  • modo.mprop.types.IntType.__floordiv__
  • modo.mprop.types.IntType.__format__
  • modo.mprop.types.IntType.__getattribute__
  • modo.mprop.types.IntType.__getnewargs__
  • modo.mprop.types.IntType.__hash__
  • modo.mprop.types.IntType.__hex__
  • modo.mprop.types.IntType.__index__
  • modo.mprop.types.IntType.__init__
  • modo.mprop.types.IntType.__int__
  • modo.mprop.types.IntType.__invert__
  • modo.mprop.types.IntType.__long__
  • modo.mprop.types.IntType.__lshift__
  • modo.mprop.types.IntType.__mod__
  • modo.mprop.types.IntType.__mul__
  • modo.mprop.types.IntType.__neg__
  • modo.mprop.types.IntType.__new__
  • modo.mprop.types.IntType.__nonzero__
  • modo.mprop.types.IntType.__oct__
  • modo.mprop.types.IntType.__or__
  • modo.mprop.types.IntType.__pos__
  • modo.mprop.types.IntType.__pow__
  • modo.mprop.types.IntType.__radd__
  • modo.mprop.types.IntType.__rand__
  • modo.mprop.types.IntType.__rdiv__
  • modo.mprop.types.IntType.__rdivmod__
  • modo.mprop.types.IntType.__reduce__
  • modo.mprop.types.IntType.__reduce_ex__
  • modo.mprop.types.IntType.__repr__
  • modo.mprop.types.IntType.__rfloordiv__
  • modo.mprop.types.IntType.__rlshift__
  • modo.mprop.types.IntType.__rmod__
  • modo.mprop.types.IntType.__rmul__
  • modo.mprop.types.IntType.__ror__
  • modo.mprop.types.IntType.__rpow__
  • modo.mprop.types.IntType.__rrshift__
  • modo.mprop.types.IntType.__rshift__
  • modo.mprop.types.IntType.__rsub__
  • modo.mprop.types.IntType.__rtruediv__
  • modo.mprop.types.IntType.__rxor__
  • modo.mprop.types.IntType.__setattr__
  • modo.mprop.types.IntType.__sizeof__
  • modo.mprop.types.IntType.__str__
  • modo.mprop.types.IntType.__sub__
  • modo.mprop.types.IntType.__subclasshook__
  • modo.mprop.types.IntType.__truediv__
  • modo.mprop.types.IntType.__trunc__
  • modo.mprop.types.IntType.__xor__
  • modo.mprop.types.IntType.bit_length
  • modo.mprop.types.IntType.conjugate
  • modo.mprop.types.IntType.denominator
  • modo.mprop.types.IntType.imag
  • modo.mprop.types.IntType.numerator
  • modo.mprop.types.IntType.real

modo.mprop.types.IntType.bit_length()

type: method_descriptor

doc: int.bit_length() -> int Number of bits necessary to represent self in binary. >>> bin(37) '0b100101' >>> (37).bit_length() 6

modo.mprop.types.IntType.conjugate()

type: method_descriptor

doc: Returns self, the complex conjugate of any int.

modo.mprop.types.IntType.denominator

type: getset_descriptor

doc: the denominator of a rational number in lowest terms

modo.mprop.types.IntType.imag

type: getset_descriptor

doc: the imaginary part of a complex number

modo.mprop.types.IntType.numerator

type: getset_descriptor

doc: the numerator of a rational number in lowest terms

modo.mprop.types.IntType.real

type: getset_descriptor

doc: the real part of a complex number

modo.mprop.types.LambdaType

type: type

doc: function(code, globals[, name[, argdefs[, closure]]]) Create a function object from a code object and a dictionary. The optional name string overrides the name from the code object. The optional argdefs tuple specifies the default argument values. The optional closure tuple supplies the bindings for free variables.

modo.mprop.types.LambdaType.func_closure

type: member_descriptor

modo.mprop.types.LambdaType.func_code

type: getset_descriptor

modo.mprop.types.LambdaType.func_defaults

type: getset_descriptor

modo.mprop.types.LambdaType.func_dict

type: getset_descriptor

modo.mprop.types.LambdaType.func_doc

type: member_descriptor

modo.mprop.types.LambdaType.func_globals

type: member_descriptor

modo.mprop.types.LambdaType.func_name

type: getset_descriptor

modo.mprop.types.ListType

type: type

doc: list() -> new empty list list(iterable) -> new list initialized from iterable's items

    modo.mprop.types.ListType contents:
  • modo.mprop.types.ListType.__add__
  • modo.mprop.types.ListType.__class__
  • modo.mprop.types.ListType.__contains__
  • modo.mprop.types.ListType.__delattr__
  • modo.mprop.types.ListType.__delitem__
  • modo.mprop.types.ListType.__delslice__
  • modo.mprop.types.ListType.__doc__
  • modo.mprop.types.ListType.__eq__
  • modo.mprop.types.ListType.__format__
  • modo.mprop.types.ListType.__ge__
  • modo.mprop.types.ListType.__getattribute__
  • modo.mprop.types.ListType.__getitem__
  • modo.mprop.types.ListType.__getslice__
  • modo.mprop.types.ListType.__gt__
  • modo.mprop.types.ListType.__hash__
  • modo.mprop.types.ListType.__iadd__
  • modo.mprop.types.ListType.__imul__
  • modo.mprop.types.ListType.__init__
  • modo.mprop.types.ListType.__iter__
  • modo.mprop.types.ListType.__le__
  • modo.mprop.types.ListType.__len__
  • modo.mprop.types.ListType.__lt__
  • modo.mprop.types.ListType.__mul__
  • modo.mprop.types.ListType.__ne__
  • modo.mprop.types.ListType.__new__
  • modo.mprop.types.ListType.__reduce__
  • modo.mprop.types.ListType.__reduce_ex__
  • modo.mprop.types.ListType.__repr__
  • modo.mprop.types.ListType.__reversed__
  • modo.mprop.types.ListType.__rmul__
  • modo.mprop.types.ListType.__setattr__
  • modo.mprop.types.ListType.__setitem__
  • modo.mprop.types.ListType.__setslice__
  • modo.mprop.types.ListType.__sizeof__
  • modo.mprop.types.ListType.__str__
  • modo.mprop.types.ListType.__subclasshook__
  • modo.mprop.types.ListType.append
  • modo.mprop.types.ListType.count
  • modo.mprop.types.ListType.extend
  • modo.mprop.types.ListType.index
  • modo.mprop.types.ListType.insert
  • modo.mprop.types.ListType.pop
  • modo.mprop.types.ListType.remove
  • modo.mprop.types.ListType.reverse
  • modo.mprop.types.ListType.sort

modo.mprop.types.ListType.append()

type: method_descriptor

doc: L.append(object) -- append object to end

modo.mprop.types.ListType.count()

type: method_descriptor

doc: L.count(value) -> integer -- return number of occurrences of value

modo.mprop.types.ListType.extend()

type: method_descriptor

doc: L.extend(iterable) -- extend list by appending elements from the iterable

modo.mprop.types.ListType.index()

type: method_descriptor

doc: L.index(value, [start, [stop]]) -> integer -- return first index of value. Raises ValueError if the value is not present.

modo.mprop.types.ListType.insert()

type: method_descriptor

doc: L.insert(index, object) -- insert object before index

modo.mprop.types.ListType.pop()

type: method_descriptor

doc: L.pop([index]) -> item -- remove and return item at index (default last). Raises IndexError if list is empty or index is out of range.

modo.mprop.types.ListType.remove()

type: method_descriptor

doc: L.remove(value) -- remove first occurrence of value. Raises ValueError if the value is not present.

modo.mprop.types.ListType.reverse()

type: method_descriptor

doc: L.reverse() -- reverse *IN PLACE*

modo.mprop.types.ListType.sort()

type: method_descriptor

doc: L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*; cmp(x, y) -> -1, 0, 1

modo.mprop.types.LongType

type: type

doc: long(x[, base]) -> integer Convert a string or number to a long integer, if possible. A floating point argument will be truncated towards zero (this does not include a string representation of a floating point number!) When converting a string, use the optional base. It is an error to supply a base when converting a non-string.

    modo.mprop.types.LongType contents:
  • modo.mprop.types.LongType.__abs__
  • modo.mprop.types.LongType.__add__
  • modo.mprop.types.LongType.__and__
  • modo.mprop.types.LongType.__class__
  • modo.mprop.types.LongType.__cmp__
  • modo.mprop.types.LongType.__coerce__
  • modo.mprop.types.LongType.__delattr__
  • modo.mprop.types.LongType.__div__
  • modo.mprop.types.LongType.__divmod__
  • modo.mprop.types.LongType.__doc__
  • modo.mprop.types.LongType.__float__
  • modo.mprop.types.LongType.__floordiv__
  • modo.mprop.types.LongType.__format__
  • modo.mprop.types.LongType.__getattribute__
  • modo.mprop.types.LongType.__getnewargs__
  • modo.mprop.types.LongType.__hash__
  • modo.mprop.types.LongType.__hex__
  • modo.mprop.types.LongType.__index__
  • modo.mprop.types.LongType.__init__
  • modo.mprop.types.LongType.__int__
  • modo.mprop.types.LongType.__invert__
  • modo.mprop.types.LongType.__long__
  • modo.mprop.types.LongType.__lshift__
  • modo.mprop.types.LongType.__mod__
  • modo.mprop.types.LongType.__mul__
  • modo.mprop.types.LongType.__neg__
  • modo.mprop.types.LongType.__new__
  • modo.mprop.types.LongType.__nonzero__
  • modo.mprop.types.LongType.__oct__
  • modo.mprop.types.LongType.__or__
  • modo.mprop.types.LongType.__pos__
  • modo.mprop.types.LongType.__pow__
  • modo.mprop.types.LongType.__radd__
  • modo.mprop.types.LongType.__rand__
  • modo.mprop.types.LongType.__rdiv__
  • modo.mprop.types.LongType.__rdivmod__
  • modo.mprop.types.LongType.__reduce__
  • modo.mprop.types.LongType.__reduce_ex__
  • modo.mprop.types.LongType.__repr__
  • modo.mprop.types.LongType.__rfloordiv__
  • modo.mprop.types.LongType.__rlshift__
  • modo.mprop.types.LongType.__rmod__
  • modo.mprop.types.LongType.__rmul__
  • modo.mprop.types.LongType.__ror__
  • modo.mprop.types.LongType.__rpow__
  • modo.mprop.types.LongType.__rrshift__
  • modo.mprop.types.LongType.__rshift__
  • modo.mprop.types.LongType.__rsub__
  • modo.mprop.types.LongType.__rtruediv__
  • modo.mprop.types.LongType.__rxor__
  • modo.mprop.types.LongType.__setattr__
  • modo.mprop.types.LongType.__sizeof__
  • modo.mprop.types.LongType.__str__
  • modo.mprop.types.LongType.__sub__
  • modo.mprop.types.LongType.__subclasshook__
  • modo.mprop.types.LongType.__truediv__
  • modo.mprop.types.LongType.__trunc__
  • modo.mprop.types.LongType.__xor__
  • modo.mprop.types.LongType.bit_length
  • modo.mprop.types.LongType.conjugate
  • modo.mprop.types.LongType.denominator
  • modo.mprop.types.LongType.imag
  • modo.mprop.types.LongType.numerator
  • modo.mprop.types.LongType.real

modo.mprop.types.LongType.bit_length()

type: method_descriptor

doc: long.bit_length() -> int or long Number of bits necessary to represent self in binary. >>> bin(37L) '0b100101' >>> (37L).bit_length() 6

modo.mprop.types.LongType.conjugate()

type: method_descriptor

doc: Returns self, the complex conjugate of any long.

modo.mprop.types.LongType.denominator

type: getset_descriptor

doc: the denominator of a rational number in lowest terms

modo.mprop.types.LongType.imag

type: getset_descriptor

doc: the imaginary part of a complex number

modo.mprop.types.LongType.numerator

type: getset_descriptor

doc: the numerator of a rational number in lowest terms

modo.mprop.types.LongType.real

type: getset_descriptor

doc: the real part of a complex number

modo.mprop.types.MemberDescriptorType

type: type

    modo.mprop.types.MemberDescriptorType contents:
  • modo.mprop.types.MemberDescriptorType.__class__
  • modo.mprop.types.MemberDescriptorType.__delattr__
  • modo.mprop.types.MemberDescriptorType.__delete__
  • modo.mprop.types.MemberDescriptorType.__doc__
  • modo.mprop.types.MemberDescriptorType.__format__
  • modo.mprop.types.MemberDescriptorType.__get__
  • modo.mprop.types.MemberDescriptorType.__getattribute__
  • modo.mprop.types.MemberDescriptorType.__hash__
  • modo.mprop.types.MemberDescriptorType.__init__
  • modo.mprop.types.MemberDescriptorType.__name__
  • modo.mprop.types.MemberDescriptorType.__new__
  • modo.mprop.types.MemberDescriptorType.__objclass__
  • modo.mprop.types.MemberDescriptorType.__reduce__
  • modo.mprop.types.MemberDescriptorType.__reduce_ex__
  • modo.mprop.types.MemberDescriptorType.__repr__
  • modo.mprop.types.MemberDescriptorType.__set__
  • modo.mprop.types.MemberDescriptorType.__setattr__
  • modo.mprop.types.MemberDescriptorType.__sizeof__
  • modo.mprop.types.MemberDescriptorType.__str__
  • modo.mprop.types.MemberDescriptorType.__subclasshook__
modo.mprop.types.MethodType

type: type

doc: instancemethod(function, instance, class) Create an instance method object.

    modo.mprop.types.MethodType contents:
  • modo.mprop.types.MethodType.__call__
  • modo.mprop.types.MethodType.__class__
  • modo.mprop.types.MethodType.__cmp__
  • modo.mprop.types.MethodType.__delattr__
  • modo.mprop.types.MethodType.__doc__
  • modo.mprop.types.MethodType.__format__
  • modo.mprop.types.MethodType.__func__
  • modo.mprop.types.MethodType.__get__
  • modo.mprop.types.MethodType.__getattribute__
  • modo.mprop.types.MethodType.__hash__
  • modo.mprop.types.MethodType.__init__
  • modo.mprop.types.MethodType.__new__
  • modo.mprop.types.MethodType.__reduce__
  • modo.mprop.types.MethodType.__reduce_ex__
  • modo.mprop.types.MethodType.__repr__
  • modo.mprop.types.MethodType.__self__
  • modo.mprop.types.MethodType.__setattr__
  • modo.mprop.types.MethodType.__sizeof__
  • modo.mprop.types.MethodType.__str__
  • modo.mprop.types.MethodType.__subclasshook__
  • modo.mprop.types.MethodType.im_class
  • modo.mprop.types.MethodType.im_func
  • modo.mprop.types.MethodType.im_self

modo.mprop.types.MethodType.im_class

type: member_descriptor

doc: the class associated with a method

modo.mprop.types.MethodType.im_func

type: member_descriptor

doc: the function (or other callable) implementing a method

modo.mprop.types.MethodType.im_self

type: member_descriptor

doc: the instance to which a method is bound; None for unbound methods

modo.mprop.types.ModuleType

type: type

doc: module(name[, doc]) Create a module object. The name must be a string; the optional doc argument can have any type.

    modo.mprop.types.ModuleType contents:
  • modo.mprop.types.ModuleType.__class__
  • modo.mprop.types.ModuleType.__delattr__
  • modo.mprop.types.ModuleType.__dict__
  • modo.mprop.types.ModuleType.__doc__
  • modo.mprop.types.ModuleType.__format__
  • modo.mprop.types.ModuleType.__getattribute__
  • modo.mprop.types.ModuleType.__hash__
  • modo.mprop.types.ModuleType.__init__
  • modo.mprop.types.ModuleType.__new__
  • modo.mprop.types.ModuleType.__reduce__
  • modo.mprop.types.ModuleType.__reduce_ex__
  • modo.mprop.types.ModuleType.__repr__
  • modo.mprop.types.ModuleType.__setattr__
  • modo.mprop.types.ModuleType.__sizeof__
  • modo.mprop.types.ModuleType.__str__
  • modo.mprop.types.ModuleType.__subclasshook__
modo.mprop.types.NoneType

type: type

    modo.mprop.types.NoneType contents:
  • modo.mprop.types.NoneType.__class__
  • modo.mprop.types.NoneType.__delattr__
  • modo.mprop.types.NoneType.__doc__
  • modo.mprop.types.NoneType.__format__
  • modo.mprop.types.NoneType.__getattribute__
  • modo.mprop.types.NoneType.__hash__
  • modo.mprop.types.NoneType.__init__
  • modo.mprop.types.NoneType.__new__
  • modo.mprop.types.NoneType.__reduce__
  • modo.mprop.types.NoneType.__reduce_ex__
  • modo.mprop.types.NoneType.__repr__
  • modo.mprop.types.NoneType.__setattr__
  • modo.mprop.types.NoneType.__sizeof__
  • modo.mprop.types.NoneType.__str__
  • modo.mprop.types.NoneType.__subclasshook__
modo.mprop.types.NotImplementedType

type: type

    modo.mprop.types.NotImplementedType contents:
  • modo.mprop.types.NotImplementedType.__class__
  • modo.mprop.types.NotImplementedType.__delattr__
  • modo.mprop.types.NotImplementedType.__doc__
  • modo.mprop.types.NotImplementedType.__format__
  • modo.mprop.types.NotImplementedType.__getattribute__
  • modo.mprop.types.NotImplementedType.__hash__
  • modo.mprop.types.NotImplementedType.__init__
  • modo.mprop.types.NotImplementedType.__new__
  • modo.mprop.types.NotImplementedType.__reduce__
  • modo.mprop.types.NotImplementedType.__reduce_ex__
  • modo.mprop.types.NotImplementedType.__repr__
  • modo.mprop.types.NotImplementedType.__setattr__
  • modo.mprop.types.NotImplementedType.__sizeof__
  • modo.mprop.types.NotImplementedType.__str__
  • modo.mprop.types.NotImplementedType.__subclasshook__
modo.mprop.types.ObjectType

type: type

doc: The most base type

    modo.mprop.types.ObjectType contents:
  • modo.mprop.types.ObjectType.__class__
  • modo.mprop.types.ObjectType.__delattr__
  • modo.mprop.types.ObjectType.__doc__
  • modo.mprop.types.ObjectType.__format__
  • modo.mprop.types.ObjectType.__getattribute__
  • modo.mprop.types.ObjectType.__hash__
  • modo.mprop.types.ObjectType.__init__
  • modo.mprop.types.ObjectType.__new__
  • modo.mprop.types.ObjectType.__reduce__
  • modo.mprop.types.ObjectType.__reduce_ex__
  • modo.mprop.types.ObjectType.__repr__
  • modo.mprop.types.ObjectType.__setattr__
  • modo.mprop.types.ObjectType.__sizeof__
  • modo.mprop.types.ObjectType.__str__
  • modo.mprop.types.ObjectType.__subclasshook__
modo.mprop.types.SliceType

type: type

doc: slice([start,] stop[, step]) Create a slice object. This is used for extended slicing (e.g. a[0:10:2]).

    modo.mprop.types.SliceType contents:
  • modo.mprop.types.SliceType.__class__
  • modo.mprop.types.SliceType.__cmp__
  • modo.mprop.types.SliceType.__delattr__
  • modo.mprop.types.SliceType.__doc__
  • modo.mprop.types.SliceType.__format__
  • modo.mprop.types.SliceType.__getattribute__
  • modo.mprop.types.SliceType.__hash__
  • modo.mprop.types.SliceType.__init__
  • modo.mprop.types.SliceType.__new__
  • modo.mprop.types.SliceType.__reduce__
  • modo.mprop.types.SliceType.__reduce_ex__
  • modo.mprop.types.SliceType.__repr__
  • modo.mprop.types.SliceType.__setattr__
  • modo.mprop.types.SliceType.__sizeof__
  • modo.mprop.types.SliceType.__str__
  • modo.mprop.types.SliceType.__subclasshook__
  • modo.mprop.types.SliceType.indices
  • modo.mprop.types.SliceType.start
  • modo.mprop.types.SliceType.step
  • modo.mprop.types.SliceType.stop

modo.mprop.types.SliceType.indices()

type: method_descriptor

doc: S.indices(len) -> (start, stop, stride) Assuming a sequence of length len, calculate the start and stop indices, and the stride length of the extended slice described by S. Out of bounds indices are clipped in a manner consistent with the handling of normal slices.

modo.mprop.types.SliceType.start

type: member_descriptor

modo.mprop.types.SliceType.step

type: member_descriptor

modo.mprop.types.SliceType.stop

type: member_descriptor

modo.mprop.types.StringType

type: type

doc: str(object) -> string Return a nice string representation of the object. If the argument is a string, the return value is the same object.

modo.mprop.types.StringType._formatter_field_name_split()

type: method_descriptor

modo.mprop.types.StringType._formatter_parser()

type: method_descriptor

modo.mprop.types.StringType.capitalize()

type: method_descriptor

doc: S.capitalize() -> string Return a copy of the string S with only its first character capitalized.

modo.mprop.types.StringType.center()

type: method_descriptor

doc: S.center(width[, fillchar]) -> string Return S centered in a string of length width. Padding is done using the specified fill character (default is a space)

modo.mprop.types.StringType.count()

type: method_descriptor

doc: S.count(sub[, start[, end]]) -> int Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

modo.mprop.types.StringType.decode()

type: method_descriptor

doc: S.decode([encoding[,errors]]) -> object Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is 'strict' meaning that encoding errors raise a UnicodeDecodeError. Other possible values are 'ignore' and 'replace' as well as any other name registered with codecs.register_error that is able to handle UnicodeDecodeErrors.

modo.mprop.types.StringType.encode()

type: method_descriptor

doc: S.encode([encoding[,errors]]) -> object Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is 'strict' meaning that encoding errors raise a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and 'xmlcharrefreplace' as well as any other name registered with codecs.register_error that is able to handle UnicodeEncodeErrors.

modo.mprop.types.StringType.endswith()

type: method_descriptor

doc: S.endswith(suffix[, start[, end]]) -> bool Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

modo.mprop.types.StringType.expandtabs()

type: method_descriptor

doc: S.expandtabs([tabsize]) -> string Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

modo.mprop.types.StringType.find()

type: method_descriptor

doc: S.find(sub [,start [,end]]) -> int Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.

modo.mprop.types.StringType.format()

type: method_descriptor

doc: S.format(*args, **kwargs) -> string Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

modo.mprop.types.StringType.index()

type: method_descriptor

doc: S.index(sub [,start [,end]]) -> int Like S.find() but raise ValueError when the substring is not found.

modo.mprop.types.StringType.isalnum()

type: method_descriptor

doc: S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

modo.mprop.types.StringType.isalpha()

type: method_descriptor

doc: S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

modo.mprop.types.StringType.isdigit()

type: method_descriptor

doc: S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

modo.mprop.types.StringType.islower()

type: method_descriptor

doc: S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

modo.mprop.types.StringType.isspace()

type: method_descriptor

doc: S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

modo.mprop.types.StringType.istitle()

type: method_descriptor

doc: S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. uppercase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

modo.mprop.types.StringType.isupper()

type: method_descriptor

doc: S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

modo.mprop.types.StringType.join()

type: method_descriptor

doc: S.join(iterable) -> string Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

modo.mprop.types.StringType.ljust()

type: method_descriptor

doc: S.ljust(width[, fillchar]) -> string Return S left-justified in a string of length width. Padding is done using the specified fill character (default is a space).

modo.mprop.types.StringType.lower()

type: method_descriptor

doc: S.lower() -> string Return a copy of the string S converted to lowercase.

modo.mprop.types.StringType.lstrip()

type: method_descriptor

doc: S.lstrip([chars]) -> string or unicode Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

modo.mprop.types.StringType.partition()

type: method_descriptor

doc: S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

modo.mprop.types.StringType.replace()

type: method_descriptor

doc: S.replace(old, new[, count]) -> string Return a copy of string S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

modo.mprop.types.StringType.rfind()

type: method_descriptor

doc: S.rfind(sub [,start [,end]]) -> int Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.

modo.mprop.types.StringType.rindex()

type: method_descriptor

doc: S.rindex(sub [,start [,end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

modo.mprop.types.StringType.rjust()

type: method_descriptor

doc: S.rjust(width[, fillchar]) -> string Return S right-justified in a string of length width. Padding is done using the specified fill character (default is a space)

modo.mprop.types.StringType.rpartition()

type: method_descriptor

doc: S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

modo.mprop.types.StringType.rsplit()

type: method_descriptor

doc: S.rsplit([sep [,maxsplit]]) -> list of strings Return a list of the words in the string S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator.

modo.mprop.types.StringType.rstrip()

type: method_descriptor

doc: S.rstrip([chars]) -> string or unicode Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

modo.mprop.types.StringType.split()

type: method_descriptor

doc: S.split([sep [,maxsplit]]) -> list of strings Return a list of the words in the string S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

modo.mprop.types.StringType.splitlines()

type: method_descriptor

doc: S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

modo.mprop.types.StringType.startswith()

type: method_descriptor

doc: S.startswith(prefix[, start[, end]]) -> bool Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

modo.mprop.types.StringType.strip()

type: method_descriptor

doc: S.strip([chars]) -> string or unicode Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is unicode, S will be converted to unicode before stripping

modo.mprop.types.StringType.swapcase()

type: method_descriptor

doc: S.swapcase() -> string Return a copy of the string S with uppercase characters converted to lowercase and vice versa.

modo.mprop.types.StringType.title()

type: method_descriptor

doc: S.title() -> string Return a titlecased version of S, i.e. words start with uppercase characters, all remaining cased characters have lowercase.

modo.mprop.types.StringType.translate()

type: method_descriptor

doc: S.translate(table [,deletechars]) -> string Return a copy of the string S, where all characters occurring in the optional argument deletechars are removed, and the remaining characters have been mapped through the given translation table, which must be a string of length 256 or None. If the table argument is None, no translation is applied and the operation simply removes the characters in deletechars.

modo.mprop.types.StringType.upper()

type: method_descriptor

doc: S.upper() -> string Return a copy of the string S converted to uppercase.

modo.mprop.types.StringType.zfill()

type: method_descriptor

doc: S.zfill(width) -> string Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

modo.mprop.types.StringTypes

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.mprop.types.TracebackType

type: type

    modo.mprop.types.TracebackType contents:
  • modo.mprop.types.TracebackType.__class__
  • modo.mprop.types.TracebackType.__delattr__
  • modo.mprop.types.TracebackType.__doc__
  • modo.mprop.types.TracebackType.__format__
  • modo.mprop.types.TracebackType.__getattribute__
  • modo.mprop.types.TracebackType.__hash__
  • modo.mprop.types.TracebackType.__init__
  • modo.mprop.types.TracebackType.__new__
  • modo.mprop.types.TracebackType.__reduce__
  • modo.mprop.types.TracebackType.__reduce_ex__
  • modo.mprop.types.TracebackType.__repr__
  • modo.mprop.types.TracebackType.__setattr__
  • modo.mprop.types.TracebackType.__sizeof__
  • modo.mprop.types.TracebackType.__str__
  • modo.mprop.types.TracebackType.__subclasshook__
  • modo.mprop.types.TracebackType.tb_frame
  • modo.mprop.types.TracebackType.tb_lasti
  • modo.mprop.types.TracebackType.tb_lineno
  • modo.mprop.types.TracebackType.tb_next

modo.mprop.types.TracebackType.tb_frame

type: member_descriptor

modo.mprop.types.TracebackType.tb_lasti

type: member_descriptor

modo.mprop.types.TracebackType.tb_lineno

type: member_descriptor

modo.mprop.types.TracebackType.tb_next

type: member_descriptor

modo.mprop.types.TupleType

type: type

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

    modo.mprop.types.TupleType contents:
  • modo.mprop.types.TupleType.__add__
  • modo.mprop.types.TupleType.__class__
  • modo.mprop.types.TupleType.__contains__
  • modo.mprop.types.TupleType.__delattr__
  • modo.mprop.types.TupleType.__doc__
  • modo.mprop.types.TupleType.__eq__
  • modo.mprop.types.TupleType.__format__
  • modo.mprop.types.TupleType.__ge__
  • modo.mprop.types.TupleType.__getattribute__
  • modo.mprop.types.TupleType.__getitem__
  • modo.mprop.types.TupleType.__getnewargs__
  • modo.mprop.types.TupleType.__getslice__
  • modo.mprop.types.TupleType.__gt__
  • modo.mprop.types.TupleType.__hash__
  • modo.mprop.types.TupleType.__init__
  • modo.mprop.types.TupleType.__iter__
  • modo.mprop.types.TupleType.__le__
  • modo.mprop.types.TupleType.__len__
  • modo.mprop.types.TupleType.__lt__
  • modo.mprop.types.TupleType.__mul__
  • modo.mprop.types.TupleType.__ne__
  • modo.mprop.types.TupleType.__new__
  • modo.mprop.types.TupleType.__reduce__
  • modo.mprop.types.TupleType.__reduce_ex__
  • modo.mprop.types.TupleType.__repr__
  • modo.mprop.types.TupleType.__rmul__
  • modo.mprop.types.TupleType.__setattr__
  • modo.mprop.types.TupleType.__sizeof__
  • modo.mprop.types.TupleType.__str__
  • modo.mprop.types.TupleType.__subclasshook__
  • modo.mprop.types.TupleType.count
  • modo.mprop.types.TupleType.index

modo.mprop.types.TupleType.count()

type: method_descriptor

doc: T.count(value) -> integer -- return number of occurrences of value

modo.mprop.types.TupleType.index()

type: method_descriptor

doc: T.index(value, [start, [stop]]) -> integer -- return first index of value. Raises ValueError if the value is not present.

modo.mprop.types.TypeType

type: type

doc: type(object) -> the object's type type(name, bases, dict) -> a new type

    modo.mprop.types.TypeType contents:
  • modo.mprop.types.TypeType.__base__
  • modo.mprop.types.TypeType.__bases__
  • modo.mprop.types.TypeType.__basicsize__
  • modo.mprop.types.TypeType.__call__
  • modo.mprop.types.TypeType.__class__
  • modo.mprop.types.TypeType.__delattr__
  • modo.mprop.types.TypeType.__dict__
  • modo.mprop.types.TypeType.__dictoffset__
  • modo.mprop.types.TypeType.__doc__
  • modo.mprop.types.TypeType.__eq__
  • modo.mprop.types.TypeType.__flags__
  • modo.mprop.types.TypeType.__format__
  • modo.mprop.types.TypeType.__ge__
  • modo.mprop.types.TypeType.__getattribute__
  • modo.mprop.types.TypeType.__gt__
  • modo.mprop.types.TypeType.__hash__
  • modo.mprop.types.TypeType.__init__
  • modo.mprop.types.TypeType.__instancecheck__
  • modo.mprop.types.TypeType.__itemsize__
  • modo.mprop.types.TypeType.__le__
  • modo.mprop.types.TypeType.__lt__
  • modo.mprop.types.TypeType.__module__
  • modo.mprop.types.TypeType.__mro__
  • modo.mprop.types.TypeType.__name__
  • modo.mprop.types.TypeType.__ne__
  • modo.mprop.types.TypeType.__new__
  • modo.mprop.types.TypeType.__reduce__
  • modo.mprop.types.TypeType.__reduce_ex__
  • modo.mprop.types.TypeType.__repr__
  • modo.mprop.types.TypeType.__setattr__
  • modo.mprop.types.TypeType.__sizeof__
  • modo.mprop.types.TypeType.__str__
  • modo.mprop.types.TypeType.__subclasscheck__
  • modo.mprop.types.TypeType.__subclasses__
  • modo.mprop.types.TypeType.__subclasshook__
  • modo.mprop.types.TypeType.__weakrefoffset__
  • modo.mprop.types.TypeType.mro

modo.mprop.types.TypeType.mro()

type: method_descriptor

doc: mro() -> list return a type's method resolution order

modo.mprop.types.UnboundMethodType

type: type

doc: instancemethod(function, instance, class) Create an instance method object.

    modo.mprop.types.UnboundMethodType contents:
  • modo.mprop.types.UnboundMethodType.__call__
  • modo.mprop.types.UnboundMethodType.__class__
  • modo.mprop.types.UnboundMethodType.__cmp__
  • modo.mprop.types.UnboundMethodType.__delattr__
  • modo.mprop.types.UnboundMethodType.__doc__
  • modo.mprop.types.UnboundMethodType.__format__
  • modo.mprop.types.UnboundMethodType.__func__
  • modo.mprop.types.UnboundMethodType.__get__
  • modo.mprop.types.UnboundMethodType.__getattribute__
  • modo.mprop.types.UnboundMethodType.__hash__
  • modo.mprop.types.UnboundMethodType.__init__
  • modo.mprop.types.UnboundMethodType.__new__
  • modo.mprop.types.UnboundMethodType.__reduce__
  • modo.mprop.types.UnboundMethodType.__reduce_ex__
  • modo.mprop.types.UnboundMethodType.__repr__
  • modo.mprop.types.UnboundMethodType.__self__
  • modo.mprop.types.UnboundMethodType.__setattr__
  • modo.mprop.types.UnboundMethodType.__sizeof__
  • modo.mprop.types.UnboundMethodType.__str__
  • modo.mprop.types.UnboundMethodType.__subclasshook__
  • modo.mprop.types.UnboundMethodType.im_class
  • modo.mprop.types.UnboundMethodType.im_func
  • modo.mprop.types.UnboundMethodType.im_self

modo.mprop.types.UnboundMethodType.im_class

type: member_descriptor

doc: the class associated with a method

modo.mprop.types.UnboundMethodType.im_func

type: member_descriptor

doc: the function (or other callable) implementing a method

modo.mprop.types.UnboundMethodType.im_self

type: member_descriptor

doc: the instance to which a method is bound; None for unbound methods

modo.mprop.types.UnicodeType

type: type

doc: unicode(string [, encoding[, errors]]) -> object Create a new Unicode object from the given encoded string. encoding defaults to the current default string encoding. errors can be 'strict', 'replace' or 'ignore' and defaults to 'strict'.

modo.mprop.types.UnicodeType._formatter_field_name_split()

type: method_descriptor

modo.mprop.types.UnicodeType._formatter_parser()

type: method_descriptor

modo.mprop.types.UnicodeType.capitalize()

type: method_descriptor

doc: S.capitalize() -> unicode Return a capitalized version of S, i.e. make the first character have upper case and the rest lower case.

modo.mprop.types.UnicodeType.center()

type: method_descriptor

doc: S.center(width[, fillchar]) -> unicode Return S centered in a Unicode string of length width. Padding is done using the specified fill character (default is a space)

modo.mprop.types.UnicodeType.count()

type: method_descriptor

doc: S.count(sub[, start[, end]]) -> int Return the number of non-overlapping occurrences of substring sub in Unicode string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

modo.mprop.types.UnicodeType.decode()

type: method_descriptor

doc: S.decode([encoding[,errors]]) -> string or unicode Decodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is 'strict' meaning that encoding errors raise a UnicodeDecodeError. Other possible values are 'ignore' and 'replace' as well as any other name registered with codecs.register_error that is able to handle UnicodeDecodeErrors.

modo.mprop.types.UnicodeType.encode()

type: method_descriptor

doc: S.encode([encoding[,errors]]) -> string or unicode Encodes S using the codec registered for encoding. encoding defaults to the default encoding. errors may be given to set a different error handling scheme. Default is 'strict' meaning that encoding errors raise a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and 'xmlcharrefreplace' as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

modo.mprop.types.UnicodeType.endswith()

type: method_descriptor

doc: S.endswith(suffix[, start[, end]]) -> bool Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

modo.mprop.types.UnicodeType.expandtabs()

type: method_descriptor

doc: S.expandtabs([tabsize]) -> unicode Return a copy of S where all tab characters are expanded using spaces. If tabsize is not given, a tab size of 8 characters is assumed.

modo.mprop.types.UnicodeType.find()

type: method_descriptor

doc: S.find(sub [,start [,end]]) -> int Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.

modo.mprop.types.UnicodeType.format()

type: method_descriptor

doc: S.format(*args, **kwargs) -> unicode Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

modo.mprop.types.UnicodeType.index()

type: method_descriptor

doc: S.index(sub [,start [,end]]) -> int Like S.find() but raise ValueError when the substring is not found.

modo.mprop.types.UnicodeType.isalnum()

type: method_descriptor

doc: S.isalnum() -> bool Return True if all characters in S are alphanumeric and there is at least one character in S, False otherwise.

modo.mprop.types.UnicodeType.isalpha()

type: method_descriptor

doc: S.isalpha() -> bool Return True if all characters in S are alphabetic and there is at least one character in S, False otherwise.

modo.mprop.types.UnicodeType.isdecimal()

type: method_descriptor

doc: S.isdecimal() -> bool Return True if there are only decimal characters in S, False otherwise.

modo.mprop.types.UnicodeType.isdigit()

type: method_descriptor

doc: S.isdigit() -> bool Return True if all characters in S are digits and there is at least one character in S, False otherwise.

modo.mprop.types.UnicodeType.islower()

type: method_descriptor

doc: S.islower() -> bool Return True if all cased characters in S are lowercase and there is at least one cased character in S, False otherwise.

modo.mprop.types.UnicodeType.isnumeric()

type: method_descriptor

doc: S.isnumeric() -> bool Return True if there are only numeric characters in S, False otherwise.

modo.mprop.types.UnicodeType.isspace()

type: method_descriptor

doc: S.isspace() -> bool Return True if all characters in S are whitespace and there is at least one character in S, False otherwise.

modo.mprop.types.UnicodeType.istitle()

type: method_descriptor

doc: S.istitle() -> bool Return True if S is a titlecased string and there is at least one character in S, i.e. upper- and titlecase characters may only follow uncased characters and lowercase characters only cased ones. Return False otherwise.

modo.mprop.types.UnicodeType.isupper()

type: method_descriptor

doc: S.isupper() -> bool Return True if all cased characters in S are uppercase and there is at least one cased character in S, False otherwise.

modo.mprop.types.UnicodeType.join()

type: method_descriptor

doc: S.join(iterable) -> unicode Return a string which is the concatenation of the strings in the iterable. The separator between elements is S.

modo.mprop.types.UnicodeType.ljust()

type: method_descriptor

doc: S.ljust(width[, fillchar]) -> int Return S left-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

modo.mprop.types.UnicodeType.lower()

type: method_descriptor

doc: S.lower() -> unicode Return a copy of the string S converted to lowercase.

modo.mprop.types.UnicodeType.lstrip()

type: method_descriptor

doc: S.lstrip([chars]) -> unicode Return a copy of the string S with leading whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

modo.mprop.types.UnicodeType.partition()

type: method_descriptor

doc: S.partition(sep) -> (head, sep, tail) Search for the separator sep in S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return S and two empty strings.

modo.mprop.types.UnicodeType.replace()

type: method_descriptor

doc: S.replace(old, new[, count]) -> unicode Return a copy of S with all occurrences of substring old replaced by new. If the optional argument count is given, only the first count occurrences are replaced.

modo.mprop.types.UnicodeType.rfind()

type: method_descriptor

doc: S.rfind(sub [,start [,end]]) -> int Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation. Return -1 on failure.

modo.mprop.types.UnicodeType.rindex()

type: method_descriptor

doc: S.rindex(sub [,start [,end]]) -> int Like S.rfind() but raise ValueError when the substring is not found.

modo.mprop.types.UnicodeType.rjust()

type: method_descriptor

doc: S.rjust(width[, fillchar]) -> unicode Return S right-justified in a Unicode string of length width. Padding is done using the specified fill character (default is a space).

modo.mprop.types.UnicodeType.rpartition()

type: method_descriptor

doc: S.rpartition(sep) -> (head, sep, tail) Search for the separator sep in S, starting at the end of S, and return the part before it, the separator itself, and the part after it. If the separator is not found, return two empty strings and S.

modo.mprop.types.UnicodeType.rsplit()

type: method_descriptor

doc: S.rsplit([sep [,maxsplit]]) -> list of strings Return a list of the words in S, using sep as the delimiter string, starting at the end of the string and working to the front. If maxsplit is given, at most maxsplit splits are done. If sep is not specified, any whitespace string is a separator.

modo.mprop.types.UnicodeType.rstrip()

type: method_descriptor

doc: S.rstrip([chars]) -> unicode Return a copy of the string S with trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

modo.mprop.types.UnicodeType.split()

type: method_descriptor

doc: S.split([sep [,maxsplit]]) -> list of strings Return a list of the words in S, using sep as the delimiter string. If maxsplit is given, at most maxsplit splits are done. If sep is not specified or is None, any whitespace string is a separator and empty strings are removed from the result.

modo.mprop.types.UnicodeType.splitlines()

type: method_descriptor

doc: S.splitlines([keepends]) -> list of strings Return a list of the lines in S, breaking at line boundaries. Line breaks are not included in the resulting list unless keepends is given and true.

modo.mprop.types.UnicodeType.startswith()

type: method_descriptor

doc: S.startswith(prefix[, start[, end]]) -> bool Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

modo.mprop.types.UnicodeType.strip()

type: method_descriptor

doc: S.strip([chars]) -> unicode Return a copy of the string S with leading and trailing whitespace removed. If chars is given and not None, remove characters in chars instead. If chars is a str, it will be converted to unicode before stripping

modo.mprop.types.UnicodeType.swapcase()

type: method_descriptor

doc: S.swapcase() -> unicode Return a copy of S with uppercase characters converted to lowercase and vice versa.

modo.mprop.types.UnicodeType.title()

type: method_descriptor

doc: S.title() -> unicode Return a titlecased version of S, i.e. words start with title case characters, all remaining cased characters have lower case.

modo.mprop.types.UnicodeType.translate()

type: method_descriptor

doc: S.translate(table) -> unicode Return a copy of the string S, where all characters have been mapped through the given translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, Unicode strings or None. Unmapped characters are left untouched. Characters mapped to None are deleted.

modo.mprop.types.UnicodeType.upper()

type: method_descriptor

doc: S.upper() -> unicode Return a copy of S converted to uppercase.

modo.mprop.types.UnicodeType.zfill()

type: method_descriptor

doc: S.zfill(width) -> unicode Pad a numeric string S with zeros on the left, to fill a field of the specified width. The string S is never truncated.

modo.mprop.types.XRangeType

type: type

doc: xrange([start,] stop[, step]) -> xrange object Like range(), but instead of returning a list, returns an object that generates the numbers in the range on demand. For looping, this is slightly faster than range() and more memory efficient.

    modo.mprop.types.XRangeType contents:
  • modo.mprop.types.XRangeType.__class__
  • modo.mprop.types.XRangeType.__delattr__
  • modo.mprop.types.XRangeType.__doc__
  • modo.mprop.types.XRangeType.__format__
  • modo.mprop.types.XRangeType.__getattribute__
  • modo.mprop.types.XRangeType.__getitem__
  • modo.mprop.types.XRangeType.__hash__
  • modo.mprop.types.XRangeType.__init__
  • modo.mprop.types.XRangeType.__iter__
  • modo.mprop.types.XRangeType.__len__
  • modo.mprop.types.XRangeType.__new__
  • modo.mprop.types.XRangeType.__reduce__
  • modo.mprop.types.XRangeType.__reduce_ex__
  • modo.mprop.types.XRangeType.__repr__
  • modo.mprop.types.XRangeType.__reversed__
  • modo.mprop.types.XRangeType.__setattr__
  • modo.mprop.types.XRangeType.__sizeof__
  • modo.mprop.types.XRangeType.__str__
  • modo.mprop.types.XRangeType.__subclasshook__

modo.PhotometricLight

type: type

doc: Photometric (ies) light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Photometric Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Photometric Light item. :param light: Optional Photometric light item object (type lx.symbol.sITYPE_PHOTOMETRYLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Photometric light item selected. :raises TypeError: if the item passed as an argument isn't either a Photometric light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight._item

type: property

modo.PhotometricLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.PhotometricLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.PhotometricLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.PhotometricLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.PhotometricLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.PhotometricLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.PhotometricLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.PhotometricLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.PhotometricLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.PhotometricLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.PhotometricLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.PhotometricLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.PhotometricLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.PhotometricLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.PhotometricLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.PhotometricLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.PhotometricLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.PhotometricLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.PhotometricLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.PhotometricLight.scene

type: property

modo.PhotometricLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.PhotometricLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PhotometricLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.PhotometricLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.PhotometricLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.PointLight

type: type

doc: Point light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Point Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Point Light item. :param light: Optional Point light item object (type lx.symbol.sITYPE_POINTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Point light item selected. :raises TypeError: if the item passed as an argument isn't either a Point light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight._item

type: property

modo.PointLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.PointLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.PointLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.PointLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.PointLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.PointLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.PointLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.PointLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.PointLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.PointLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.PointLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.PointLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.PointLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.PointLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.PointLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.PointLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.PointLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.PointLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.PointLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.PointLight.scene

type: property

modo.PointLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.PointLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.PointLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.PointLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.PointLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Portal

type: type

doc: Portal item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Portal' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Portal item. :param light: Optional Portal item object (type 'portal') or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Portal item selected. :raises TypeError: if the item passed as an argument isn't either a Portal item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal._item

type: property

modo.Portal._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.Portal.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.Portal.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.Portal.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.Portal.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.Portal.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.Portal.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.Portal.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.Portal.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.Portal.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.Portal.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.Portal.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.Portal.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.Portal.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.Portal.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.Portal.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Portal.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Portal.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Portal.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.Portal.scene

type: property

modo.Portal.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.Portal.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.Portal.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Portal.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.Portal.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.Quaternion

type: type

doc: Minimal quaternion class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion._Quaternion__dTolerance

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion._quaternion_identity

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion._quaternion_length

type: function

doc: This function calculates the length of the quaternion. :param Quaternion q: :returns float:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion._quaternion_normalize

type: function

doc: This function normalizes a quaternion, setting the length of the quaternion to 1.0. :param Quaternion q: :return:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion.copy(self)

type: instancemethod

doc: Returns a copy of this quaternion object

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion.fromMatrix3(self,input)

type: instancemethod

doc: This function converts a matrix into a quaternion, containing the same rotation. :param Matrix3 input: :param Quaternion output:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion.fromMatrix4(self,input)

type: instancemethod

doc: This function converts a matrix into a quaternion, containing the same rotation. :param Matrix4 input:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion.getAxisAngle(self)

type: instancemethod

doc: Returns the axis and angle of this quaternion :returns tuple: Axis [tuple] and angle [float]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion.length(self)

type: instancemethod

doc: Returns the length of this quaternion

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion.normalize(self)

type: instancemethod

doc: Normalizes the quaternion in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion.setAxisAngle(self,axis,angle)

type: instancemethod

doc: This function takes an axis and an angle, and calculates a quaternion that encodes that rotation. :param float angle: Angle in radians :param Vector3 axis: Axis

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion.toMatrix3(self)

type: instancemethod

doc: This function converts a quaternion into a Matrix3, containing the same rotation. :return Matrix3: Result

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion.toMatrix4(self)

type: instancemethod

doc: :returns Matrix4: This quaternion as Matrix4, containing the same rotation

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Quaternion.w

type: property

doc: Quick access to the w component of the quaternion

modo.Quaternion.x

type: property

doc: Quick access to the x component of the quaternion

modo.Quaternion.y

type: property

doc: Quick access to the y component of the quaternion

modo.Quaternion.z

type: property

doc: Quick access to the z component of the quaternion

modo.RenderPassGroup

type: type

doc: Render pass group :param groupItem: either a group item or an item name/ID to look up. :type groupItem: lx.object.item or modo.item.Item :raises TypeError: if the item is not a 'Group" item. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup._item

type: property

modo.RenderPassGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.addPass(self,name)

type: instancemethod

doc: Add a render pass item to the group. :param name: optional name for the render pass :type name: basestring :return: the render pass item. :rtype: modo.item.ActionClip

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.RenderPassGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.RenderPassGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.RenderPassGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.RenderPassGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.RenderPassGroup.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.RenderPassGroup.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.RenderPassGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.RenderPassGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.RenderPassGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.RenderPassGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.RenderPassGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.RenderPassGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.RenderPassGroup.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.RenderPassGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.RenderPassGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.RenderPassGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.RenderPassGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.RenderPassGroup.passes

type: property

doc: :getter: Returns a lst of render passes in the group. :returns: list of render pass items :rtype: list of modo.item.ActionClip

modo.RenderPassGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.scene

type: property

modo.RenderPassGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.RenderPassGroup.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.RenderPassGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.RenderPassGroup.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.RGBAMap

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.RGBAMap._accessor

type: property

modo.RGBAMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.RGBAMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.RGBAMap.fromMesh(cls)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.RGBAMap.id

type: property

modo.RGBAMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.RGBMap

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.RGBMap._accessor

type: property

modo.RGBMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.RGBMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.RGBMap.fromMesh(cls)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.RGBMap.id

type: property

modo.RGBMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.Scene

type: type

doc: The main scene class. Takes an optional lx.object.Scene object as an argument. If none is provided (the default) then the currently selected scene is used which will mostly be the general case. The module function :func:`sceneList` makes use of the scene parameter to return a list of open scenes as modo.scene.Scene objects. :param scene: Optional scene object to wrap. :type scene: lx.object.Scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene._allItems(self)

type: instancemethod

doc: Utility function to get all items of a scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene._Scene__ItemAdd(self,groupType)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene._Scene__setupTextureLayerType(self,newItem)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.actors

type: property

doc: Returns a list of all actors in the scene :getter: Returns a list of Actor objects found in this scene :rtype: list

modo.Scene.addActor(self,name,items,makeActive)

type: instancemethod

doc: Add a new actor to the scene :returns modo.item.Actor: Actor item object :param basestring name: optional name :param list items: list of items for the actor to contain

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.addCamera(self,name)

type: instancemethod

doc: Add a new camera item to the scene :returns: camera item :rtype: modo.item.Camera :param name: optional name for the camera. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.addGroup(self,name,gtype)

type: instancemethod

doc: Add a new group item to the scene :returns: group item :rtype: modo.item.Group :param name: optional name for the group item. :type name: basestring :param gtype: optional group type, can be one of the default group types ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader') or any other string to create a custom group type. Default is an empty string which creates a 'Genera' group type. :type gtype: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.addItem(self,itype,name)

type: instancemethod

doc: Add a new item to the scene :returns: item :rtype: modo.item.item :param itype: item type :type itype: modo.Constant :param name: optional name for the item. :type name: basestring :raises TypeError: When failing

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.addJointLocator(self,name,parent)

type: instancemethod

doc: Adds a new joint to the scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.addMaterial(self,matType,name,index)

type: instancemethod

doc: Adds a new material to the scene :param modo.c.MATERIAL_* matType: Type of material to create :param name: Optional name for the material :returns Item: The material item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.addMesh(self,name)

type: instancemethod

doc: Add a new mesh item to the scene :returns: mesh item :rtype: modo.item.Mesh :param name: optional name for the mesh. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.addRenderPassGroup(self,name)

type: instancemethod

doc: Add a render pass group to the scene :returns: render pass group. :rtype: modo.item.RenderPassGroup :param name: optional name for the render pass group. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.camera(self,cam)

type: instancemethod

doc: Returns a camera item in the scene. The supplied argument can be either a string (camera ID or name) or an integer (camera index in the scene's collection of cameras) :param cam: the camera :type cam: basestring or int :returns: camera item :rtype: modo.item.Camera

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.cameraCount

type: property

doc: Number of cameras in the scene. :getter: Returns the number of camera items. :rtype: int

modo.Scene.cameras

type: property

doc: Returns a list of all the camera items in the scene as modo.item.Camera objects. :getter: Returns a list of the camera items in the scene. :rtype: list of modo.item.Camera

modo.Scene.currentRange

type: property

doc: Set or read the current frame range start and end frame value should be passed in as a tuple. :setter: Sets the range :param frange: frame range - a tuple of ints (start, end). :type frange: tuple :Getter: Returns the start and end frames. :rtype: tuple :exception ValueError: if supplied start frame is higher than end frame.

modo.Scene.deformers(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.deselect(self,itemObj)

type: instancemethod

doc: Deselect an item. :param itemObj: the item to deselect. Clears the entire selection if None :type itemObj: basestring (item name or ID) or instance of either lx.object.Item or modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.duplicateItem(self,item,instance)

type: instancemethod

doc: Creates and returns a duplicate of the passed item :returns item: Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.filename

type: property

doc: File path of the scene. :getter: Returns the file path of the scene or 'None' if not yet saved. :rtype: basestring or None

modo.Scene.fps

type: property

doc: Scene frames per second. .. note:: There is no way to set the fps value from the Python API for any scene other than the currently selected one. Therefore, for any other scene the property will be read only and attempts to write to it will throw an AttributeError. | :getter: Returns the Frames Per Second :rtype: float :setter: Sets the Frames Per Second :param fps: Scene frames per second. :type fps: float :raises: AttributeError

modo.Scene.getGroups(self,gtype)

type: instancemethod

doc: Returns all groups of the given kind :param gtype: optional group type, can be one of the default group types ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader') or any other string to create a custom group type. Default is an empty string which creates a 'Genera' group type. You can also pass a list of multiple group types. :returns list: List of groups matching the type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.groups

type: property

doc: Returns a list of all the group items in the scene as modo.item.Group objects. :getter: Returns a list of the group items in the scene. :rtype: list of modo.item.Group

modo.Scene.item(self,name)

type: instancemethod

doc: Look up item by name :param string item: Name to look for :returns item: Found item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.itemCount(self,itype)

type: instancemethod

doc: The number of items of a specified type in the scene. :param itype: type of the items. :type itype: int or basestring :returns: the number of items of the specified type in the scene. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.items(self,itype,name,superType)

type: instancemethod

doc: List of items of the specified type in the scene. :param itype: the item type. :type itype: :param basestring name: Optionally filter result by this text. Can use * and ? wildcards for globbing. :param bool superType: If True, all items that have 'itype' as superType are listed. Else, only items of specifically that type are returned. :returns: list of the items of the specified type in the scene. If itype is None, all items in the scene are returned. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.iterItems(self,itype,name,superType)

type: instancemethod

doc: Same as items(), but returns a generator object.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.lightCount

type: property

doc: Number of lights in the scene. :getter: Returns the number of light items. :rtype: int

modo.Scene.locators

type: property

modo.Scene.meshCount

type: property

doc: Number of mesh items in the scene. :getter: Returns the number of mesh items. :rtype: int

modo.Scene.meshes

type: property

doc: Returns a list of all the mesh items in the scene as modo.item.Mesh objects. :getter: Returns a list of the mesh items in the scene. :rtype: list of modo.item.Mesh

modo.Scene.name

type: property

doc: Friendly name of the scene. :getter: Returns the name of the scene. :rtype: basestring

modo.Scene.removeItems(self,itm,children)

type: instancemethod

doc: :param Item: Item to remove from the scene :param bool children: If True, all found children are deleted also

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.renderCamera

type: property

doc: Get & set the scene's current render camera :setter: Set the scene's current render camera :param camera: the camera item to set as the current render camera. :type camera: lx.object.Item of type 'Camera' :getter: Returns the current render camera. :rtype: modo.Item.Camera

modo.Scene.renderItem

type: property

doc: :getter: Returns the first found render item of the scene :rtype: Item

modo.Scene.renderPassGroups

type: property

doc: Returns a list of all the render pass group items in the scene as modo.item.RenderPassGroup objects. :getter: Returns a list of the render pass group items in the scene. :rtype: list of modo.item.Group

modo.Scene.sceneItem

type: property

doc: The scene's 'scene item' :getter: Returns the scene's scene item. :rtype: lxdt.item.Item (type lx.symbol.sITYPE_SCENE)

modo.Scene.sceneRange

type: property

doc: Set or read the scene's frame range start and end frame value should be passed in as a tuple. :setter: Sets the range :param frange: frame range - a tuple of ints (start, end). :type frange: tuple :getter: Returns the start and end frames. :rtype: tuple :exception ValueError: if supplied start frame is higher than end frame.

modo.Scene.select(self,itemObj,add)

type: instancemethod

doc: :param itemObj: the item to select. :type item: basestring (item name or ID) or instance of either lx.object.Item or modo.item.Item :param add: whether to add to the current selection, False replaces the current selection. :type add: bool Note:: To clear the selection of the scene, please use deselect() instead.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.Scene.selected

type: property

doc: Selected items in the scene. :getter: Returns the selected items :rtype: list

modo.Scene.selectedByType(self,itype,superType)

type: instancemethod

doc: Returns the selected items of a specific type as modo.item.Item objects. :param itype: item type to filter on. :type itype: int or string :return: selcted items of specified type. :param bool superType: If True, all items derived fom itype are listed. Otherwise only items of the exact type of itype. :rtype: list of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene

type: module

doc: .. module:: modo.scene :synopsis: Scene class and scene level utility functions. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.scene.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.scene.ChannelRead contents:
  • modo.scene.ChannelRead.__class__
  • modo.scene.ChannelRead.__delattr__
  • modo.scene.ChannelRead.__dict__
  • modo.scene.ChannelRead.__doc__
  • modo.scene.ChannelRead.__format__
  • modo.scene.ChannelRead.__getattr__
  • modo.scene.ChannelRead.__getattribute__
  • modo.scene.ChannelRead.__hash__
  • modo.scene.ChannelRead.__init__
  • modo.scene.ChannelRead.__module__
  • modo.scene.ChannelRead.__new__
  • modo.scene.ChannelRead.__reduce__
  • modo.scene.ChannelRead.__reduce_ex__
  • modo.scene.ChannelRead.__repr__
  • modo.scene.ChannelRead.__setattr__
  • modo.scene.ChannelRead.__sizeof__
  • modo.scene.ChannelRead.__str__
  • modo.scene.ChannelRead.__subclasshook__
  • modo.scene.ChannelRead.__weakref__
  • modo.scene.ChannelRead.set

modo.scene.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.scene.ChannelWrite contents:
  • modo.scene.ChannelWrite.__class__
  • modo.scene.ChannelWrite.__delattr__
  • modo.scene.ChannelWrite.__dict__
  • modo.scene.ChannelWrite.__doc__
  • modo.scene.ChannelWrite.__format__
  • modo.scene.ChannelWrite.__getattr__
  • modo.scene.ChannelWrite.__getattribute__
  • modo.scene.ChannelWrite.__hash__
  • modo.scene.ChannelWrite.__init__
  • modo.scene.ChannelWrite.__module__
  • modo.scene.ChannelWrite.__new__
  • modo.scene.ChannelWrite.__reduce__
  • modo.scene.ChannelWrite.__reduce_ex__
  • modo.scene.ChannelWrite.__repr__
  • modo.scene.ChannelWrite.__setattr__
  • modo.scene.ChannelWrite.__sizeof__
  • modo.scene.ChannelWrite.__str__
  • modo.scene.ChannelWrite.__subclasshook__
  • modo.scene.ChannelWrite.__weakref__
  • modo.scene.ChannelWrite.set

modo.scene.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.current

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.scene.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip

type: type

doc: Action Clip and Render pass item. :param item: either an item of type 'actionclip' or an item name/ID to lookup. :type item: an instance of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip._item

type: property

modo.scene.item.ActionClip._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.active

type: property

doc: Set or get the active state of the render pass. :getter: Returns the active state of the render pass. :rtype: bool :setter: Sets the active state of the renter pass :param state: active state. :type state: bool

modo.scene.item.ActionClip.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.ActionClip.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.ActionClip.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.ActionClip.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.ActionClip.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.enabled

type: property

doc: Get or set the enabled state of the render pass. :getter: Returns the enabled state. :rtype: bool :setter: Sets the enabled state of the render pass :param state: enabled state. :type state: bool

modo.scene.item.ActionClip.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.getValue(self,chan,time)

type: instancemethod

doc: Read a value set on a channel for this render pass. :param chan: the channel to read the value from. :type chan: modo.channel.Channel object :param time: the time (in seconds) to read the value for, defaults to 0.0. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.ActionClip.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.ActionClip.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.ActionClip.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.ActionClip.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.ActionClip.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.ActionClip.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.name

type: property

doc: Name of the render pass. :getter: Returns the name of the render pass :rtype: basestring :setter: Assigns a new name to the render pass :param name: new name for the render pass. :type name: basestring

modo.scene.item.ActionClip.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.ActionClip.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.ActionClip.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.ActionClip.passGroup

type: property

doc: The render pass group that the render pass belongs to. :getter: Returns the render pass group :rtype: modo.item.RenderPassGroup :setter: Sets the render pass group :param group: render pass group to parent to. :type group: modo.item.RenderPassGroup

modo.scene.item.ActionClip.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.scene

type: property

modo.scene.item.ActionClip.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.ActionClip.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.setValue(self,chan,value,time,key)

type: instancemethod

doc: Set a value on a channel for this render pass. :param chan: the channel to set the value on. :type chan: modo.channel.Channel object :param value: the value to set for the channel. :type value: any :param time: the time (in seconds) to set the value for, defaults to 0.0. :type time: float :param key: whether to set a key for the value or not, defaults to False. :param key: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ActionClip.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.ActionClip.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Actor

type: type

doc: Wrapper class for actor groups.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor._Actor__addClip(self,name,pose)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor._item

type: property

modo.scene.item.Actor._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.actions

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.scene.item.Actor.addAction(self,name)

type: instancemethod

doc: Adds an action to this actor Note: please avoid naming actions 'setup', 'edit' or 'scene' :returns ActionClip: ActionClip :param basestring name: Optional name for the action

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.addPose(self,name,activate)

type: instancemethod

doc: Adds a pose to this actor :returns ActionClip: ActionClip :param basestring name: Optional name for the pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.Actor.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.Actor.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.Actor.currentAction

type: property

doc: :getter: Returns the currently active action if any. None if no action is active :rtype: ActionClip

modo.scene.item.Actor.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.Actor.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.scene.item.Actor.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.scene.item.Actor.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.Actor.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.Actor.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.Actor.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.Actor.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.scene.item.Actor.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.Actor.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.Actor.items

type: property

doc: :getter: Returns a list of LocatorSuperType items that are connected to this action. :rtype: list

modo.scene.item.Actor.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.Actor.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.Actor.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.Actor.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.Actor.pose(self,poseName)

type: instancemethod

doc: Return a pose by name :param basestring poseName: Name of the pose to look up :returns: Pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.poses

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.scene.item.Actor.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.scene

type: property

modo.scene.item.Actor.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.Actor.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Actor.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Actor.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.scene.item.AreaLight

type: type

doc: Area light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Area Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. :param light: Optional area light item object (type lx.symbol.sITYPE_AREALIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid area light item selected. :raises TypeError: if the item passed as an argument isn't either an area light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight._item

type: property

modo.scene.item.AreaLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.AreaLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.AreaLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.AreaLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.AreaLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.AreaLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.AreaLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.AreaLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.AreaLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.AreaLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.AreaLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.item.AreaLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.AreaLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.AreaLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.AreaLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.AreaLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.AreaLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.AreaLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.AreaLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.AreaLight.scene

type: property

modo.scene.item.AreaLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.AreaLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.AreaLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.AreaLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.AreaLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.scene.item.Camera

type: type

doc: Camera item class. Takes an optional 'camera' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'camera' or an item name or ID to look up. If no camera item is supplied as an argument an attempt will be made to wrap the most recently selected camera. :param camera: Optional camera item object (type lx.symbol.sITYPE_CAMERA) or string (item name or ID) to look up. :type camera: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid camera item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'camera' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the camera argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera._item

type: property

modo.scene.item.Camera._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.Camera.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.Camera.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.Camera.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.Camera.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.Camera.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.Camera.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.Camera.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.Camera.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.Camera.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.Camera.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.Camera.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.Camera.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.Camera.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.Camera.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Camera.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Camera.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Camera.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Camera.scene

type: property

modo.scene.item.Camera.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.Camera.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Camera.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Camera.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.Camera.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Channel

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Add a link between this channel and another. :param to_channel: The channel to link to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Channel.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Delete a link from the channel graph. :param to_channel: The channel the link is to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Channel.disconnectInput(self,other)

type: instancemethod

doc: Removes an input connection from another channel if it exists. :param Channel other: Other channel to disconnect from. If it is None, all input connections are removed.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Channel.envelope

type: property

doc: Returns the channel's animation envelope. :getter: Returns the channel's animation envelope. :rtype: modo.channel.Envelope :raises LookupError: if the channel isn't animated.

modo.scene.item.Channel.evalType

type: property

doc: Returns the evaluation type of a channel, which is the type of slot allocated in the eval state vector. This will return the "gradstack" exo-type for gradient channels. :getter: Returns the evaluation type of the channel :rtype: basestring

modo.scene.item.Channel.forward(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index forward of this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index forward of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Channel.fwdCount

type: property

doc: Returns the number of linked channels forward of this channel in this channel graph. :getter: Returns the number of linked channels forward of this channel in this channel graph. :rtype: int

modo.scene.item.Channel.fwdLinked

type: property

doc: Returns a list of the linked channels forward of this channel in the channel graph. :getter: Returns the forward channels in this item's channel graph. :rtype: list

modo.scene.item.Channel.get(self,time,action)

type: instancemethod

doc: Returns a channel's value for an action at a specific time. Defaults to reading the channel's evaluated value at the current time. :param time: Optional time in seconds to read the value at. :type time: float :param action: The action to read the value from. Defaults to None (evaluation). :type action: basestring :returns: the channel's value. :rtype: depends on the type of the channel being read.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Channel.graph

type: property

doc: The channel's channel graph. :getter: Returns the channel's channel graph. :rtype: lxu.object.ChannelGraph

modo.scene.item.Channel.index

type: property

doc: The channel's index. :getter: Returns the channel's index. :rtype: int

modo.scene.item.Channel.isAnimated

type: property

doc: Returns whether the channel is animated. :getter: Returns whether the channel is animated or not. :rtype: bool

modo.scene.item.Channel.item

type: property

doc: :getter: Returns the item that is associated with this channel :rtype: Item

modo.scene.item.Channel.name

type: property

doc: The channel's name. :getter: Returns the channel's name. :rtype: basestring

modo.scene.item.Channel.revCount

type: property

doc: Returns the number of linked channels that occur before this channel in the channel graph. :getter: Returns the number of linked channels that occur before this channel in the channel graph. :rtype: int

modo.scene.item.Channel.reverse(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index before this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index before of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Channel.revLinked

type: property

doc: Returns a list of the linked channels that appear before this channel in the channel graph. :getter: Returns the linked channels that appear before this channel in the channel graph. :rtype: list

modo.scene.item.Channel.set(self,value,time,key,action)

type: instancemethod

doc: Sets a channel's value for an action at a specific time. Defaults to setting the channel's value for the "edit" action and at the current time. :param value: The value to set for the channel. :type value: depends on the type of the channel :param time: optional time in seconds to set the value for. :type time: float :param key: Specifies whether to set a key for the channel. :type key: bool :param action: The action to set the value on. :type action: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Set a link's position (from index, to index) in the channel graph. :param from_index: The index in the channel graph for the current (from) channel. :type from_index: int :param to_channel: The to channel. :type to_channel: modo.channel.Channel :param to_index: the index in the channel graph for the 'to' channel. :type to_index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Channel.storageType

type: property

doc: Returns the storage type of the channel, which can be valid exo-type name for numeric and stored custom types or None if no storage type is found. :getter: Returns the channel storage type :rtype: basestring

modo.scene.item.Channel.type

type: property

doc: Returns the channel type. The numeric and gradient types can be keyframed. The return type is an int which translates to the following types: | 0: none | 1: integer | 2: float | 3: gradient | 4: storage | 5: eval :getter: Returns the channel type. :rtype: int

modo.scene.item.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.scene.item.ChannelRead contents:
  • modo.scene.item.ChannelRead.__class__
  • modo.scene.item.ChannelRead.__delattr__
  • modo.scene.item.ChannelRead.__dict__
  • modo.scene.item.ChannelRead.__doc__
  • modo.scene.item.ChannelRead.__format__
  • modo.scene.item.ChannelRead.__getattr__
  • modo.scene.item.ChannelRead.__getattribute__
  • modo.scene.item.ChannelRead.__hash__
  • modo.scene.item.ChannelRead.__init__
  • modo.scene.item.ChannelRead.__module__
  • modo.scene.item.ChannelRead.__new__
  • modo.scene.item.ChannelRead.__reduce__
  • modo.scene.item.ChannelRead.__reduce_ex__
  • modo.scene.item.ChannelRead.__repr__
  • modo.scene.item.ChannelRead.__setattr__
  • modo.scene.item.ChannelRead.__sizeof__
  • modo.scene.item.ChannelRead.__str__
  • modo.scene.item.ChannelRead.__subclasshook__
  • modo.scene.item.ChannelRead.__weakref__
  • modo.scene.item.ChannelRead.set

modo.scene.item.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.ChannelTriple

type: type

doc: Wrapper to allow setting and reading all three channels on a vector 'channel' at once :param basestring channelName: The channel name. eg 'diffCol' :param modo.item.Item item: The item the channel belongs to. :raises: LookUpError if no respective channel of the given name was found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.scene.item.ChannelTriple contents:
  • modo.scene.item.ChannelTriple.__class__
  • modo.scene.item.ChannelTriple.__delattr__
  • modo.scene.item.ChannelTriple.__dict__
  • modo.scene.item.ChannelTriple.__doc__
  • modo.scene.item.ChannelTriple.__format__
  • modo.scene.item.ChannelTriple.__getattribute__
  • modo.scene.item.ChannelTriple.__hash__
  • modo.scene.item.ChannelTriple.__init__
  • modo.scene.item.ChannelTriple.__module__
  • modo.scene.item.ChannelTriple.__new__
  • modo.scene.item.ChannelTriple.__reduce__
  • modo.scene.item.ChannelTriple.__reduce_ex__
  • modo.scene.item.ChannelTriple.__repr__
  • modo.scene.item.ChannelTriple.__setattr__
  • modo.scene.item.ChannelTriple.__sizeof__
  • modo.scene.item.ChannelTriple.__str__
  • modo.scene.item.ChannelTriple.__subclasshook__
  • modo.scene.item.ChannelTriple.__weakref__
  • modo.scene.item.ChannelTriple.get
  • modo.scene.item.ChannelTriple.set

modo.scene.item.ChannelTriple.get(self)

type: instancemethod

doc: Same arguments as Channel.get()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.ChannelTriple.set(self,values,time,action)

type: instancemethod

doc: Sets three values for the three channels at once :param float time: Time in seconds for the value to be set at (optional) :param basestring action: Action to set the value for (optional)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.scene.item.ChannelWrite contents:
  • modo.scene.item.ChannelWrite.__class__
  • modo.scene.item.ChannelWrite.__delattr__
  • modo.scene.item.ChannelWrite.__dict__
  • modo.scene.item.ChannelWrite.__doc__
  • modo.scene.item.ChannelWrite.__format__
  • modo.scene.item.ChannelWrite.__getattr__
  • modo.scene.item.ChannelWrite.__getattribute__
  • modo.scene.item.ChannelWrite.__hash__
  • modo.scene.item.ChannelWrite.__init__
  • modo.scene.item.ChannelWrite.__module__
  • modo.scene.item.ChannelWrite.__new__
  • modo.scene.item.ChannelWrite.__reduce__
  • modo.scene.item.ChannelWrite.__reduce_ex__
  • modo.scene.item.ChannelWrite.__repr__
  • modo.scene.item.ChannelWrite.__setattr__
  • modo.scene.item.ChannelWrite.__sizeof__
  • modo.scene.item.ChannelWrite.__str__
  • modo.scene.item.ChannelWrite.__subclasshook__
  • modo.scene.item.ChannelWrite.__weakref__
  • modo.scene.item.ChannelWrite.set

modo.scene.item.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.CylinderLight

type: type

doc: Cylinder light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Cylinder Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Cylinder Light item. :param light: Optional Cylinder light item object (type lx.symbol.sITYPE_CYLINDERLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid cylinder light item selected. :raises TypeError: if the item passed as an argument isn't either a cylinder light or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight._item

type: property

modo.scene.item.CylinderLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.CylinderLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.CylinderLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.CylinderLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.CylinderLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.CylinderLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.CylinderLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.CylinderLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.CylinderLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.CylinderLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.CylinderLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.item.CylinderLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.CylinderLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.CylinderLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.CylinderLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.CylinderLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.CylinderLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.CylinderLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.CylinderLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.CylinderLight.scene

type: property

modo.scene.item.CylinderLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.CylinderLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.CylinderLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.CylinderLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.CylinderLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Deformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer._item

type: property

modo.scene.item.Deformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.Deformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.Deformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.Deformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.Deformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.Deformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.Deformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.Deformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.Deformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.Deformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.Deformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.scene.item.Deformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.Deformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.scene.item.Deformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.Deformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.Deformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.Deformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.scene

type: property

modo.scene.item.Deformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.Deformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Deformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Deformer.svc

type: Deformer

modo.scene.item.Deformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.DeformerGroup

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup._item

type: property

modo.scene.item.DeformerGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.DeformerGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.DeformerGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.DeformerGroup.connectInput(self,other)

type: instancemethod

doc: Connects an influence deformer into this deformGroup :param other:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.createJointLocator(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.DeformerGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.DeformerGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.DeformerGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.DeformerGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.DeformerGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.DeformerGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.DeformerGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.mesh(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.DeformerGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.DeformerGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.DeformerGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.DeformerGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.scene

type: property

modo.scene.item.DeformerGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.DeformerGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DeformerGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.DeformerGroup.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.DirectionalLight

type: type

doc: Directional light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Directional Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Directional Light item. :param light: Optional Directional light item object (type lx.symbol.sITYPE_SUNLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid directional light item selected. :raises TypeError: if the item passed as an argument isn't either a Directional light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight._item

type: property

modo.scene.item.DirectionalLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.DirectionalLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.DirectionalLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.DirectionalLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.DirectionalLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.DirectionalLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.DirectionalLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.DirectionalLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.DirectionalLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.DirectionalLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.DirectionalLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.item.DirectionalLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.DirectionalLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.DirectionalLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.DirectionalLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.DirectionalLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.DirectionalLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.DirectionalLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.DirectionalLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.DirectionalLight.scene

type: property

modo.scene.item.DirectionalLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.DirectionalLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DirectionalLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.DirectionalLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.DirectionalLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.DomeLight

type: type

doc: Dome light item class Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Dome Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Dome Light item. :param light: Optional Dome light item object (type lx.symbol.sITYPE_DOMELIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Dome light item selected. :raises TypeError: if the item passed as an argument isn't either a Dome light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight._item

type: property

modo.scene.item.DomeLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.DomeLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.DomeLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.DomeLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.DomeLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.DomeLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.DomeLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.DomeLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.DomeLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.DomeLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.DomeLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.item.DomeLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.DomeLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.DomeLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.DomeLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.DomeLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.DomeLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.DomeLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.DomeLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.DomeLight.scene

type: property

modo.scene.item.DomeLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.DomeLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.DomeLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.DomeLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.DomeLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Envelope

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Envelope.behavior

type: property

doc: gets/sets the behavior of times for both before the first keyframe and after the last keyframe in the envelope. :setter: Sets the envelope behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope behavior :rtype: int

modo.scene.item.Envelope.clear(self)

type: instancemethod

doc: Clears (removes all keys from) the envelope.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Envelope.interpolation

type: property

doc: Returns the interpolation setting for the envelope. Can be one of: | lx.symbol.iENVv_INTERP_CURVE | lx.symbol.iENVv_INTERP_LINEAR | lx.symbol.iENVv_INTERP_STEPPED :getter: Returns the interpolation setting for the envelope. :rtype: int

modo.scene.item.Envelope.isInt

type: property

doc: Returns whether the envelope is integer-valued type, if not it's a float type. :Getter: Returns True if the envelope is integer-valued type, False otherwise. :rtype: bool

modo.scene.item.Envelope.keyframes

type: property

doc: Returns a :class:`Keyframes` object that provides access to the keyframes set for the envelope and methods to manipulate them. :getter: Returns a :class:`Keyframes` object containing the keys for this envelope. :rtype: modo.channel.Keyframes

modo.scene.item.Envelope.postBehaviour

type: property

doc: gets/sets the behavior of times after the last keyframe in the envelope. :setter: Sets the envelope post behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope post behavior :rtype: int

modo.scene.item.Envelope.preBehaviour

type: property

doc: gets/sets the behavior of times before the first keyframe in the envelope. - **RESET** A default value, or may be just zero. - **CONSTANT** The value of the first or last keyframe. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **REPEAT** The values in the keyframe range repeating continuously. - **OSCILLATE** Like repeat, but the values run forwards and backward alternately. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **OFFSETREPEAT** Like repeat, but the values are offset in each cycle by the difference between the first and last keyframes. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **LINEAR** Linear interpolation from the slope at the nearest keyframe. - **NONE** Indicates that the envelope does not exist before or after the explicit keyframe range. This can be used by motion evaluation code to decide whether to use the envelope for a channel or to look up the parent envelope or default value. - **CONSTANT_KEEP_SLOPE** As for constant except that the slopes of the first or last keys are not changed. - **OSCILLATE_KEEP_SLOPE** As for oscillate except that the slopes of the first or last keys are not changed. - **OFFSETREPEAT_KEEP_SLOPE** As for offset repeat except that the slopes of the first or last keys are not changed. :setter: Sets the behavior :param behavior: the behaviour to set for the envelope. Can be one of: | lx.symbol.iENV_RESET | lx.symbol.iENV_CONSTANT | lx.symbol.iENV_REPEAT | lx.symbol.iENV_OSCILLATE | lx.symbol.iENV_OFFSETREPEAT | lx.symbol.iENV_LINEAR | lx.symbol.iENV_NONE | lx.symbol.iENV_CONSTANT_KEEP_SLOPE | lx.symbol.iENV_OSCILLATE_KEEP_SLOPE | lx.symbol.iENV_OFFSETREPEAT_KEEP_SLOPE :type behavior: int :getter: Returns envelope behavior :rtype: int

modo.scene.item.Envelope.value(self,time)

type: instancemethod

doc: Returns the value of the envelope evaluated at the specified time. If no time is explicitly provided the value of the envelope at the current time is returned :param time: time to evaluate envelope at. :type time: float :returns: value of the envelope :rtype: float for float type envelopes, int for integer-valued type envelopes

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.scene.item.GeneralInfluenceDeformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer._item

type: property

modo.scene.item.GeneralInfluenceDeformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.GeneralInfluenceDeformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.GeneralInfluenceDeformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.GeneralInfluenceDeformer.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.GeneralInfluenceDeformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.GeneralInfluenceDeformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.GeneralInfluenceDeformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.GeneralInfluenceDeformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.GeneralInfluenceDeformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.GeneralInfluenceDeformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.GeneralInfluenceDeformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.mapName

type: property

doc: :getter: Returns the UI version of the map name as string

modo.scene.item.GeneralInfluenceDeformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.scene.item.GeneralInfluenceDeformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.GeneralInfluenceDeformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.scene.item.GeneralInfluenceDeformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.GeneralInfluenceDeformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.GeneralInfluenceDeformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.GeneralInfluenceDeformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.scene

type: property

modo.scene.item.GeneralInfluenceDeformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.GeneralInfluenceDeformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GeneralInfluenceDeformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.GeneralInfluenceDeformer.svc

type: Deformer

modo.scene.item.GeneralInfluenceDeformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Group

type: type

doc: A group item. Takes an optional 'groupItem' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group' or an item name or ID to look up. If no groupItem is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. 'gtype' can be any one of the built in group types by passing one of the built in type strings ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader'), an empty string for a general group or any other string to create a custom group type. :param groupItem: an optional group item (type lx.symbol.sITYPE_GROUP) or an item name/ID to look up. :type groupItem: an instance of lx.object.Item, lxu.object.item or modo.item.Item :param gtype: the group type. :type gtype: basestring :raises TypeError: if an item is supplied as the groupItem argument but is not of type lx.symbol.sITYPE_GROUP. :raises ValueError: if no groupItem argument is supplied and no valid group item is selected in the scene. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found. Note that the children() method derived from the Item object will only list child groups. To iterate the contained items, use the method items.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group._item

type: property

modo.scene.item.Group._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.Group.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.Group.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.Group.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.Group.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.scene.item.Group.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.scene.item.Group.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.Group.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.Group.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.Group.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.Group.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.scene.item.Group.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.Group.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.Group.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.scene.item.Group.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.Group.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.Group.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.Group.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.Group.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.scene

type: property

modo.scene.item.Group.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.Group.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Group.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Group.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.scene.item.GroupLocator

type: type

doc: Group locator item class. Takes an optional 'grploc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group locator' or an item name or ID to look up. If no grploc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param grploc: Optional group locator item object (type lx.symbol.sITYPE_GROUPLOCATOR) or string (item name or ID) to look up. :type grploc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid group locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'group locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the grploc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator._item

type: property

modo.scene.item.GroupLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.GroupLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.GroupLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.GroupLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.GroupLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.GroupLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.GroupLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.GroupLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.GroupLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.GroupLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.GroupLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.GroupLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.GroupLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.GroupLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.GroupLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.GroupLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.GroupLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.GroupLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.GroupLocator.scene

type: property

modo.scene.item.GroupLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.GroupLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.GroupLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.GroupLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.GroupLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Item

type: type

doc: Base item class Takes an optional lx.object.Item object as an argument. If none is provided (the default) then the most recently selected item is used. :param item: Optional item object to wrap. :type item: an instance of lx.object.Item or lxu.object.item :raises ValueError: if no item is passed as an argument and no valid items are currently selected. :raises LookupError: if a string (item name or ID) is passed as the item argument and no item with that name or ID cane be found in the scene. :raises TypeError: if the object passed as the 'item' argument isn't an instance of lx.object.Item.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item._item

type: property

modo.scene.item.Item._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.Item.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.Item.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.Item.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.Item.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.Item.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.Item.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.Item.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.Item.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.Item.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.Item.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.Item.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.Item.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.Item.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.Item.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.scene

type: property

modo.scene.item.Item.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.Item.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Item.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Item.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.ItemGraph

type: type

doc: Utility container class for quick access to ItemGraph compatible graphs :param item: Item to look up graph for :param ls.symbol.sGRAPH_* graphType: Graph to look up. Common ones are 'parent', 'deformers', 'groups', 'chanMods' :param bool reverse: Indices traverse the graph forwards if false or reverse if true

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ItemGraph._ItemGraph__toType

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ItemGraph.connectedItems

type: property

doc: :getter: Returns a dictionary that lists the input- and output items at once. :rtype: dictionary

modo.scene.item.ItemGraph.connectInput(self,other)

type: instancemethod

doc: Connects the given item as input. This function is called by the >> operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ItemGraph.disconnectInput(self,other)

type: instancemethod

doc: Removes the given item from the input connections if any. This function is called by the << operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ItemGraph.forward(self,index)

type: instancemethod

doc: :returns list: Items of the forward connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ItemGraph.item

type: property

doc: :getter: Returns the Item that this ItemGraph instance is bound to. :return type: Item

modo.scene.item.ItemGraph.reverse(self,index)

type: instancemethod

doc: :returns list: Items of the reverse connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ItemGraph.setReverse(self,reverse)

type: instancemethod

doc: Sets the direction that is used for lookup when using the angular brackets [] :param bool reverse: If True the graph is looked up forwards, if False, backwards.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.ItemGraph.type

type: property

doc: :getter: Returns the name of the graph type that this instance represents. :return type: basestring

modo.scene.item.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.Joint

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint._item

type: property

modo.scene.item.Joint._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.Joint.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.Joint.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.Joint.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.Joint.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.Joint.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.Joint.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.Joint.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.Joint.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.Joint.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.Joint.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.Joint.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.Joint.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.Joint.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.Joint.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Joint.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Joint.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Joint.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Joint.scene

type: property

modo.scene.item.Joint.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.Joint.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Joint.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Joint.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.Joint.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Keyframes

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Keyframes._indexFromTime(self,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Keyframes.add(self,val,time)

type: instancemethod

doc: Adds a new keyframe at the specified time. If no time value is passed as an argument a keyframe is set at the current time. :param time: optional time (in seconds) to add a keyframe at. :type time: float :param val: the value to set for the keyframe :type val: int or float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Keyframes.delete(self)

type: instancemethod

doc: Deletes the current key

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Keyframes.first(self)

type: instancemethod

doc: Go to the first keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Keyframes.getSlopeType(self,side)

type: instancemethod

doc: Returns the slope type for either side of a keyframe. :returns: a tuple of the slope type set for the side of the keyframe specified and whether the slope is weighted or not. :rtype: (int, int)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Keyframes.last(self)

type: instancemethod

doc: Go to the last keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Keyframes.next(self)

type: instancemethod

doc: Go to the next keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Keyframes.numKeys

type: property

doc: :getter: Returns the number of keyframes found :rtype: int

modo.scene.item.Keyframes.prev(self)

type: instancemethod

doc: Go to the previous keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Keyframes.setIndex(self,index)

type: instancemethod

doc: Go to the keyframe by index

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Keyframes.setSlopeType(self,stype,side)

type: instancemethod

doc: Sets the slope type for either side of a keyframe - **SLOPE_DIRECT** the slope of the tangent is set based on the value stored in the key. - **SLOPE_AUTO** the slope of the tangent is calculated automatically with regard to surrounding keys. This is similar to the slope adjustments made by TCB curves. - **SLOPE_LINEAR_IN** the slope of the tangent is calculated to align with the previous key's value. - **SLOPE_LINEAR_OUT** the slope of the tangent is calculated to align with the next key's value. - **SLOPE_FLAT** The slope of the tangent is set to zero. - **SLOPE_AUTOFLAT** the same as auto but if a neighboring key has the same value as the key the slope is set to zero. - **SLOPE_STEPPED** Maintains the value of the previous key between pairs of keys. :param stype: set the slope type for the current keyframe. Can be one of: | lx.symbol.iSLOPE_AUTO | lx.symbol.iSLOPE_AUTOFLAT | lx.symbol.iSLOPE_DIRECT | lx.symbol.iSLOPE_FLAT | lx.symbol.iSLOPE_LINEAR_IN | lx.symbol.iSLOPE_LINEAR_OUT | lx.symbol.iSLOPE_STEPPED :type stype: int :param side: the side of the key (in or out) the slope type is being set for :type side: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.item.Keyframes.time

type: property

doc: Returns & sets the time for the current keyframe. :setter: Sets the time :param time: the time to move the key to. :type time: float :getter: Returns the time of the current keyframe :rtype: float

modo.scene.item.Keyframes.value

type: property

doc: Convenience property to get & set value of the current keyframe for the 90% case of an unbroken key. :setter: Sets a value :param val: the value to set for the key. :type val: int or float :getter: Returns the value of an (unbroken) key. :rtype: int or float

modo.scene.item.Light

type: type

doc: Base Light item class. Each light item encapsulates both an lx.object.Item object (via inheritance from the Item class) of a specific modo light type and a corresponding lx.object.Item of type 'lightMaterial' as a :class:`LightMaterial` object via the light's material property. example:: # to set the diffuse color on the currently selected spotlight spotlight = modo.SpotLight() spotlight.material.ch_diffCol.set((0.7, 0.1, 0.5)) .. note:: Although "Light" isn't technically a base class since, like all other classes in modo.item, it inherits from "Item", it does encapsulate modo's 'Light" supertype and can be treated as a kind of 'pseudo' base class for all modo's light types. As such it should not be instantiated directly, create one of the specific light types instead. | :param light: Optional light item object to wrap. Must be a specific type of light, not the light supertype. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid light item selected. :raises TypeError: if the item passed as an argument isn't an instance of a specific subclass of Light.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light._item

type: property

modo.scene.item.Light._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.Light.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.Light.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.Light.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.Light.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.Light.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.Light.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.Light.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.Light.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.Light.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.Light.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.item.Light.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.Light.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.Light.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.Light.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.Light.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Light.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Light.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Light.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Light.scene

type: property

modo.scene.item.Light.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.Light.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Light.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Light.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.Light.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.LightMaterial

type: type

doc: Wraps a light material texture layer item. :param material: the light material item to be wrapped. :type material: lx.object.Item of type lx.symbol.sITYPE_LIGHTMATERIAL

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial._item

type: property

modo.scene.item.LightMaterial._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.LightMaterial.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.LightMaterial.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.LightMaterial.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.LightMaterial.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.LightMaterial.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.LightMaterial.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.LightMaterial.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.LightMaterial.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.LightMaterial.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.LightMaterial.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.light

type: property

doc: :getter: The light item that the material belongs to. :param light_item: the light item to parent the material layer to. :type light_item: an instance of one of the modo.Light types or either lx.object.Item or lxu.object.Item of a specific light item type :returns: the parent light item. :rtype: one of the modo light types.

modo.scene.item.LightMaterial.lightCol

type: property

doc: A wrapper property for the light material item's three diffuse color channels. Returns an :class:`modo.channel.Channel` object :getter: Returns a channelTriple object. :rtype: modo.channel.channelTriple

modo.scene.item.LightMaterial.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.LightMaterial.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.LightMaterial.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.LightMaterial.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.LightMaterial.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.scatteringCol

type: property

doc: :getter: A wrapper property for the light material item's three scattering color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.scene.item.LightMaterial.scene

type: property

modo.scene.item.LightMaterial.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.LightMaterial.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LightMaterial.shadCol

type: property

doc: :getter: A wrapper property for the light material item's three shadow color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.scene.item.LightMaterial.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.LightMaterial.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Locator

type: type

doc: Locator item class. Takes an optional 'locator' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'locator' or an item name or ID to look up. If no locator item is supplied as an argument an attempt will be made to wrap the most recently selected locator item. :param locator: Optional locator item object (type lx.symbol.sITYPE_LOCATOR) or string (item name or ID) to look up. :type locator: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the locator argument but no item with that name/ID can be found. Hint: Items of other locator derived types should be casted as LocatorSuperType, casting to this class will fail.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator._item

type: property

modo.scene.item.Locator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.Locator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.Locator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.Locator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.Locator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.Locator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.Locator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.Locator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.Locator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.Locator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.Locator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.Locator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.Locator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.Locator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.Locator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Locator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Locator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Locator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Locator.scene

type: property

modo.scene.item.Locator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.Locator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Locator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Locator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.Locator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.LocatorSuperType

type: type

doc: The LocatorSuperType reflects all items that can be seen and transformed in the 3d view. Locators have transform items that hold the respective transform channels, such as position and rotation.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType._item

type: property

modo.scene.item.LocatorSuperType._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.LocatorSuperType.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.LocatorSuperType.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.LocatorSuperType.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.LocatorSuperType.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.LocatorSuperType.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.LocatorSuperType.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.LocatorSuperType.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.LocatorSuperType.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.LocatorSuperType.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.LocatorSuperType.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.LocatorSuperType.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.LocatorSuperType.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.LocatorSuperType.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.LocatorSuperType.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.LocatorSuperType.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.LocatorSuperType.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.LocatorSuperType.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.LocatorSuperType.scene

type: property

modo.scene.item.LocatorSuperType.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.LocatorSuperType.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.LocatorSuperType.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.LocatorSuperType.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.LocatorSuperType.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Matrix4

type: type

doc: Matrix class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4._getIdentity

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4._matrix_calcRotation

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4._matrix_vectorMultiply

type: function

doc: :param matrix: :param vector: :param result: :return:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4._MatrixToEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4._rotOrderToList

type: function

doc: takes a string in form of 'xyz' and returns a list in form of [0,1,2]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4.asEuler(self,degrees,order)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4.asRotateMatrix(self)

type: instancemethod

doc: Removes the translation part of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4.copy(self)

type: instancemethod

doc: :return: A copy of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4.determinant(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4.fromEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4.invert(self)

type: instancemethod

doc: Inverts this Matrix in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4.inverted(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4.position

type: property

doc: :getter: Returns the translation part of this matrix :rtype: tuple :setter: Sets the translation part of this matrix :param position: Position :type position: iterable

modo.scene.item.Matrix4.scale(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4.set(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4.setIdentity(self)

type: instancemethod

doc: Set this matrix to it's identity

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4.transpose(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Matrix4.transposed(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal. It returns a new transposed matrix.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Mesh

type: type

doc: Mesh item class. Takes an optional 'mesh' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'mesh' or an item name or ID to look up. If no mesh item is supplied as an argument an attempt will be made to wrap the most recently selected mesh layer. :param mesh: Optional mesh item object (type lx.symbol.sITYPE_MESH) or string (item name or ID) to look up. :type mesh: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid mesh item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'mesh' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the mesh argument but no item with that name/ID can be found. The mesh geometry can be accessed by the :class:`geometry` attribute. .. py:attribute:: geometry :rtype: :class:`MeshGeometry`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh._item

type: property

modo.scene.item.Mesh._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.Mesh.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.Mesh.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.Mesh.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.Mesh.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.geometry

type: property

modo.scene.item.Mesh.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.Mesh.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.Mesh.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.Mesh.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.Mesh.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.Mesh.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.Mesh.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.Mesh.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.Mesh.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.Mesh.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.Mesh.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Mesh.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Mesh.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Mesh.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Mesh.scene

type: property

modo.scene.item.Mesh.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.Mesh.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Mesh.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Mesh.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.Mesh.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.MeshGeometry

type: type

doc: A class wrapped around lx.object.Mesh that provides access to geometry of a given Mesh Item :param item: Input item :type item: type lx.object.Item :param mode: Mode in which to access the mesh. Possible values: "write", "read", "deformed" :type mode: string. Note: References are always read only. :return: Instance of MeshGeometry :raises LookupError: If item was passed as string and could not be found in the scene :raises TypeError: If the passed item is not of type lx.object.Item :raises TypeError: If the passed item is not compatible with the mesh type example:: scene = modo.scene.current() # Get the selected mesh for mesh in scene.selectedByType("mesh")[:1]: # Print the number of vertices print len(mesh.geometry.vertices) # Print point position by index print mesh.geometry.vertices[4] # Set point position by index mesh.geometry.vertices[4] = (1,2,3) # Iterate all vertices and move them by 0.1 in x for point in mesh.geometry.vertices: point += (0.1, 0, 0) # Update to see mesh changes mesh.geometry.setMeshEdits() .. py:attribute:: vertices :rtype: :class:`MeshVertices` .. py:attribute:: edges :rtype: :class:`MeshEdges` .. py:attribute:: polygons :rtype: :class:`MeshPolygons` .. py:attribute:: vmaps :rtype: :class:`MeshMaps`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.scene.item.MeshGeometry._item

type: property

modo.scene.item.MeshGeometry._SEL_SVC

type: Selection

modo.scene.item.MeshGeometry._UNDO_SVC

type: Undo

modo.scene.item.MeshGeometry.accessMode

type: property

modo.scene.item.MeshGeometry.boundingBox

type: property

doc: Get the bounding box of this mesh :getter: Returns a tuple representing the two corners of the bounding box

modo.scene.item.MeshGeometry.getMeshCenter(self)

type: instancemethod

doc: :return: Center position of the bounding box

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.scene.item.MeshGeometry.internalMesh

type: property

doc: :getter: Returns the wrapped lx.object.Mesh object

modo.scene.item.MeshGeometry.numEdges

type: property

doc: :getter: returns the vertex count of this mesh

modo.scene.item.MeshGeometry.numPolygons

type: property

doc: :getter: returns the polygon count of this mesh

modo.scene.item.MeshGeometry.numVertices

type: property

doc: :getter: returns the vertex count of this mesh

modo.scene.item.MeshGeometry.setAccessMode(self,value,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.scene.item.MeshGeometry.setMeshEdits(self,editType)

type: instancemethod

doc: Updates mesh edits applying previous changes. :param lx.symbol.f_MESHEDIT_* editType: The type of change to set. Defaults to all.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.scene.item.PhotometricLight

type: type

doc: Photometric (ies) light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Photometric Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Photometric Light item. :param light: Optional Photometric light item object (type lx.symbol.sITYPE_PHOTOMETRYLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Photometric light item selected. :raises TypeError: if the item passed as an argument isn't either a Photometric light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight._item

type: property

modo.scene.item.PhotometricLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.PhotometricLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.PhotometricLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.PhotometricLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.PhotometricLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.PhotometricLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.PhotometricLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.PhotometricLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.PhotometricLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.PhotometricLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.PhotometricLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.item.PhotometricLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.PhotometricLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.PhotometricLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.PhotometricLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.PhotometricLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.PhotometricLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.PhotometricLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.PhotometricLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.PhotometricLight.scene

type: property

modo.scene.item.PhotometricLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.PhotometricLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PhotometricLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.PhotometricLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.PhotometricLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.PointLight

type: type

doc: Point light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Point Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Point Light item. :param light: Optional Point light item object (type lx.symbol.sITYPE_POINTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Point light item selected. :raises TypeError: if the item passed as an argument isn't either a Point light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight._item

type: property

modo.scene.item.PointLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.PointLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.PointLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.PointLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.PointLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.PointLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.PointLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.PointLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.PointLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.PointLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.PointLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.item.PointLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.PointLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.PointLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.PointLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.PointLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.PointLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.PointLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.PointLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.PointLight.scene

type: property

modo.scene.item.PointLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.PointLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.PointLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.PointLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.PointLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Portal

type: type

doc: Portal item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Portal' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Portal item. :param light: Optional Portal item object (type 'portal') or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Portal item selected. :raises TypeError: if the item passed as an argument isn't either a Portal item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal._item

type: property

modo.scene.item.Portal._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.Portal.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.Portal.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.Portal.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.Portal.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.Portal.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.Portal.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.Portal.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.Portal.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.Portal.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.Portal.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.item.Portal.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.Portal.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.Portal.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.Portal.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.Portal.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Portal.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Portal.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Portal.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.Portal.scene

type: property

modo.scene.item.Portal.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.Portal.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.Portal.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.Portal.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.Portal.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.RenderPassGroup

type: type

doc: Render pass group :param groupItem: either a group item or an item name/ID to look up. :type groupItem: lx.object.item or modo.item.Item :raises TypeError: if the item is not a 'Group" item. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup._item

type: property

modo.scene.item.RenderPassGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.addPass(self,name)

type: instancemethod

doc: Add a render pass item to the group. :param name: optional name for the render pass :type name: basestring :return: the render pass item. :rtype: modo.item.ActionClip

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.RenderPassGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.RenderPassGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.RenderPassGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.RenderPassGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.scene.item.RenderPassGroup.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.scene.item.RenderPassGroup.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.RenderPassGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.RenderPassGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.RenderPassGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.RenderPassGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.scene.item.RenderPassGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.RenderPassGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.RenderPassGroup.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.scene.item.RenderPassGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.RenderPassGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.RenderPassGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.RenderPassGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.RenderPassGroup.passes

type: property

doc: :getter: Returns a lst of render passes in the group. :returns: list of render pass items :rtype: list of modo.item.ActionClip

modo.scene.item.RenderPassGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.scene

type: property

modo.scene.item.RenderPassGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.RenderPassGroup.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.RenderPassGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.RenderPassGroup.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.scene.item.scene

type: module

doc: .. module:: modo.scene :synopsis: Scene class and scene level utility functions. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.item.SpotLight

type: type

doc: Spotlight item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Spotlight' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Spotlight item. :param light: Optional Spotlight item object (type lx.symbol.sITYPE_SPOTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Spotlight item selected. :raises TypeError: if the item passed as an argument isn't either a Spotlight item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight._item

type: property

modo.scene.item.SpotLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.SpotLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.SpotLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.SpotLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.SpotLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.SpotLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.SpotLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.SpotLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.SpotLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.SpotLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.SpotLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.item.SpotLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.SpotLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.SpotLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.SpotLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.SpotLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.SpotLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.SpotLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.SpotLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.SpotLight.scene

type: property

modo.scene.item.SpotLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.SpotLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.SpotLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.SpotLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.SpotLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.TextureLocator

type: type

doc: Texture locator item class. Takes an optional 'texloc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Texture locator' or an item name or ID to look up. If no texloc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param texloc: Optional texture locator item object (type lx.symbol.sITYPE_TEXTURELOC) or string (item name or ID) to look up. :type texloc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid texture locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'texture locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the texloc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator._item

type: property

modo.scene.item.TextureLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.TextureLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.TextureLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.TextureLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.TextureLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.TextureLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.TextureLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.TextureLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.TextureLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.TextureLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.TextureLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.TextureLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.TextureLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.TextureLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.TextureLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.TextureLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.TextureLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.TextureLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.TextureLocator.scene

type: property

modo.scene.item.TextureLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.TextureLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TextureLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.TextureLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.TextureLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.TransformItem

type: type

doc: Contains a group of animatable transform channels of a locator object. It has convenience functions for access of the locator's position, rotation and scale. examples:: # We retrieve two meshes from the current scene by name, assuming they exist cube = modo.Mesh('Cube') sphere = modo.Mesh('Sphere') # Set rotation values cube.rotation.set(10, 20, 30, degrees=True) # Link the position.x channel of the sphere to to the position.x channel of the cube cube.position.y.setLink(0, sphere.position.x, 0) # Set position values to zero cube.position.clear() # Insert keyframe for rotation on frame 21 frame = lx.service.Value().FrameToTime(21) cube.rotation.insertKey(time=frame)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem._item

type: property

modo.scene.item.TransformItem._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem._TransformItem__rotationType

type: long

modo.scene.item.TransformItem._TransformItem__scaleType

type: long

modo.scene.item.TransformItem._TransformItem__toDegrees

type: function

doc: Utility function to consume and process the 'degrees' argument for the set function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem._TransformItem__transformType(self)

type: instancemethod

doc: Utility function that returns the corresponding string value from __types, for later channel lookup

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem._TransformItem__translationType

type: long
modo.scene.item.TransformItem._TransformItem__types type: dict

modo.scene.item.TransformItem._TransformItem__types.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.scene.item.TransformItem._TransformItem__types.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.scene.item.TransformItem._TransformItem__types.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.scene.item.TransformItem._TransformItem__types.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.scene.item.TransformItem._TransformItem__types.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.scene.item.TransformItem._TransformItem__types.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.scene.item.TransformItem._TransformItem__types.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.scene.item.TransformItem._TransformItem__types.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.scene.item.TransformItem._TransformItem__types.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.scene.item.TransformItem._TransformItem__types.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.scene.item.TransformItem._TransformItem__types.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.scene.item.TransformItem._TransformItem__types.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.scene.item.TransformItem._TransformItem__types.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.scene.item.TransformItem._TransformItem__types.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.scene.item.TransformItem._TransformItem__types.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.scene.item.TransformItem._TransformItem__types.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.scene.item.TransformItem._TransformItem__types.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.scene.item.TransformItem._TransformItem__types.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.scene.item.TransformItem.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.TransformItem.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.TransformItem.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.clear(self)

type: instancemethod

doc: Sets values to 1.0 if is a scaling transform and to 0.0 otherwise :param arguments: Same as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.TransformItem.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.TransformItem.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.get(self,time,action,degrees)

type: instancemethod

doc: Function to get the x, y and z-values of the locator at once. :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when getting rotation. :param keywords: Same as as :meth:`Channel.get` :returns tuple: x, y and z values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.TransformItem.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.TransformItem.insertKey(self,time,action)

type: instancemethod

doc: Inserts a keyframe on the respective x, y and z channels. :param float time: Time in seconds to create the new keys :param action: Action to create keys in.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.TransformItem.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.TransformItem.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.TransformItem.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.TransformItem.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.TransformItem.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.TransformItem.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.TransformItem.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.TransformItem.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.removeKey(self,time,action)

type: instancemethod

doc:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.scene

type: property

modo.scene.item.TransformItem.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.TransformItem.set(self,values,time,key,action,degrees)

type: instancemethod

doc: Function to set the x, y and z-values of the locator at once. :param values: either three floats, or a list/tuple containing the x, y, z values to set :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when setting rotation. :param keywords: Same as as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItem.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.TransformItem.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.TransformItem.x

type: property

doc: Shortcut to the x channel of the locator :getter: :class:`Channel` :rtype: float

modo.scene.item.TransformItem.y

type: property

doc: Shortcut to the y channel of the locator :getter: :class:`Channel` :rtype: float

modo.scene.item.TransformItem.z

type: property

doc: Shortcut to the z channel of the locator :getter: :class:`Channel` :rtype: float

modo.scene.item.TransformItems

type: type

doc: Container class for the stacked transform items of a Locator object. Transform items contain channels for either position, rotation or scale. The order of how they are processed can be changed and new transform items can be inserted or existing ones deleted. example:: scene = modo.scene.current() # Grab first selected object for item in scene.selected[:1]: # Print the amount of transform items print len(item.transforms) # Add a new position transform item position = item.transforms.insert('position', values=(1,0,0), name='New_Position') # Add a new scale transform item scale = item.transforms.insert('scale', values=(2,2,2), name='Scaled') # Swap the indices of the first two transform items item.transforms.reposition(0,1) # Delete item.transforms.delete(scale) # Clear values of all transforms for i in item.transforms: i.clear()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems._item

type: property

modo.scene.item.TransformItems._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.item.TransformItems.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.item.TransformItems.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.item.TransformItems.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.item.TransformItems.delete(self,index)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.item.TransformItems.idNames(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.item.TransformItems.insert(self,xfrmType,placement,values,name)

type: instancemethod

doc: Insert a new transform item into the transform chain. The 'prepend' and 'append' placement values place the new item at the top or bottom of the stack, where 'pre' and 'post' place it around the respective transform highlighted in black in the channel view. I am myself confused about the order though, is it bottom to top or the other way around? Note that modo always keeps at least one of each type of transform, so when you attempt to delete it a new one is created automatically. :param string xfrmType: 'position', 'rotation' or 'scale' :param string placement: 'prepend', 'append', 'pre' or 'post' :param tuple values: Initial xyz values to be optionally set :param string name: Optional name

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.item.TransformItems.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.item.TransformItems.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.item.TransformItems.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.item.TransformItems.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.item.TransformItems.names(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.item.TransformItems.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.item.TransformItems.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.item.TransformItems.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.TransformItems.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.TransformItems.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.reposition(self,indexFrom,indexTo)

type: instancemethod

doc: Places a transform item to the provided index of the transform item stack :param int indexFrom: Source Index of the item that is to be moved :param int indexTo: Destination index to place item at

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.TransformItems.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.item.TransformItems.scene

type: property

modo.scene.item.TransformItems.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.item.TransformItems.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.TransformItems.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.TransformItems.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.item.TransformItems.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.item.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.item.util.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.scene.item.util.collections

type: module

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.scene.item.util.collections._abcoll

type: module

doc: Abstract Base Classes (ABCs) for collections, according to PEP 3119. DON'T USE THIS MODULE DIRECTLY! The classes here should be imported via collections; they are defined here only to alleviate certain bootstrapping issues. Unit tests are in test_collections.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll._hasattr

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.scene.item.util.collections._abcoll.ABCMeta

type: type

doc: Metaclass for defining Abstract Base Classes (ABCs). Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as 'virtual subclasses' -- these and their descendants will be considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won't show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via super()).

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\abc.pyc

modo.scene.item.util.collections._abcoll.abstractmethod

type: function

doc: A decorator indicating abstract methods. Requires that the metaclass is ABCMeta or derived from it. A class that has a metaclass derived from ABCMeta cannot be instantiated unless all of its abstract methods are overridden. The abstract methods can be called using any of the normal 'super' call mechanisms. Usage: class C: __metaclass__ = ABCMeta @abstractmethod def my_abstract_method(self, ...): ...

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.scene.item.util.collections._abcoll.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._abcoll.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.scene.item.util.collections._abcoll.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections._chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.scene.item.util.collections._chain contents:
  • modo.scene.item.util.collections._chain.__class__
  • modo.scene.item.util.collections._chain.__delattr__
  • modo.scene.item.util.collections._chain.__doc__
  • modo.scene.item.util.collections._chain.__format__
  • modo.scene.item.util.collections._chain.__getattribute__
  • modo.scene.item.util.collections._chain.__hash__
  • modo.scene.item.util.collections._chain.__init__
  • modo.scene.item.util.collections._chain.__iter__
  • modo.scene.item.util.collections._chain.__new__
  • modo.scene.item.util.collections._chain.__reduce__
  • modo.scene.item.util.collections._chain.__reduce_ex__
  • modo.scene.item.util.collections._chain.__repr__
  • modo.scene.item.util.collections._chain.__setattr__
  • modo.scene.item.util.collections._chain.__sizeof__
  • modo.scene.item.util.collections._chain.__str__
  • modo.scene.item.util.collections._chain.__subclasshook__
  • modo.scene.item.util.collections._chain.from_iterable
  • modo.scene.item.util.collections._chain.next

modo.scene.item.util.collections._chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.scene.item.util.collections._chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.scene.item.util.collections._get_ident()

type: builtin_function_or_method

doc: get_ident() -> integer Return a non-zero integer that uniquely identifies the current thread amongst other threads that exist simultaneously. This may be used to identify per-thread resources. Even though on some platforms threads identities may appear to be allocated consecutive numbers starting at 1, this behavior should not be relied upon, and the number should be seen purely as a magic cookie. A thread's identity may be reused for another thread after it exits.

modo.scene.item.util.collections._heapq

type: module

doc: Heap queue algorithm (a.k.a. priority queue). Heaps are arrays for which a[k] <= a[2*k+1] and a[k] <= a[2*k+2] for all k, counting elements from 0. For the sake of comparison, non-existing elements are considered to be infinite. The interesting property of a heap is that a[0] is always its smallest element. Usage: heap = [] # creates an empty heap heappush(heap, item) # pushes a new item on the heap item = heappop(heap) # pops the smallest item from the heap item = heap[0] # smallest item on the heap without popping it heapify(x) # transforms list into a heap, in-place, in linear time item = heapreplace(heap, item) # pops and returns smallest item, and adds # new item; the heap size is unchanged Our API differs from textbook heap algorithms as follows: - We use 0-based indexing. This makes the relationship between the index for a node and the indexes for its children slightly less obvious, but is more suitable since Python uses 0-based indexing. - Our heappop() method returns the smallest item, not the largest. These two make it possible to view the heap as a regular Python list without surprises: heap[0] is the smallest item, and heap.sort() maintains the heap invariant!

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\heapq.pyc

modo.scene.item.util.collections._heapq._nlargest()

type: builtin_function_or_method

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, reverse=True)[:n]

modo.scene.item.util.collections._heapq._nsmallest()

type: builtin_function_or_method

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable)[:n]

modo.scene.item.util.collections._heapq._siftdown

type: function

file: .\Lib\heapq.py

modo.scene.item.util.collections._heapq._siftup

type: function

file: .\Lib\heapq.py

modo.scene.item.util.collections._heapq.bisect

type: module

doc: Bisection algorithms.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\bisect.pyc

modo.scene.item.util.collections._heapq.chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

modo.scene.item.util.collections._heapq.cmp_lt

type: function

file: .\Lib\heapq.py

modo.scene.item.util.collections._heapq.count

type: type

doc: count(start=0, step=1) --> count object Return a count object whose .next() method returns consecutive values. Equivalent to: def count(firstval=0, step=1): x = firstval while 1: yield x x += step

modo.scene.item.util.collections._heapq.heapify()

type: builtin_function_or_method

doc: Transform list into a heap, in-place, in O(len(heap)) time.

modo.scene.item.util.collections._heapq.heappop()

type: builtin_function_or_method

doc: Pop the smallest item off the heap, maintaining the heap invariant.

modo.scene.item.util.collections._heapq.heappush()

type: builtin_function_or_method

doc: Push item onto heap, maintaining the heap invariant.

modo.scene.item.util.collections._heapq.heappushpop()

type: builtin_function_or_method

doc: Push item on the heap, then pop and return the smallest item from the heap. The combined action runs more efficiently than heappush() followed by a separate call to heappop().

modo.scene.item.util.collections._heapq.heapreplace()

type: builtin_function_or_method

doc: Pop and return the current smallest value, and add the new item. This is more efficient than heappop() followed by heappush(), and can be more appropriate when using a fixed-size heap. Note that the value returned may be larger than item! That constrains reasonable uses of this routine unless written as part of a conditional replacement: if item > heap[0]: item = heapreplace(heap, item)

modo.scene.item.util.collections._heapq.imap

type: type

doc: imap(func, *iterables) --> imap object Make an iterator that computes the function using arguments from each of the iterables. Like map() except that it returns an iterator instead of a list and that it stops when the shortest iterable is exhausted instead of filling in None for shorter iterables.

modo.scene.item.util.collections._heapq.islice

type: type

doc: islice(iterable, [start,] stop [, step]) --> islice object Return an iterator whose next() method returns selected values from an iterable. If start is specified, will skip all preceding elements; otherwise, start defaults to zero. Step defaults to one. If specified as another value, step determines how many values are skipped between successive calls. Works like a slice() on a list but returns an iterator.

modo.scene.item.util.collections._heapq.itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

modo.scene.item.util.collections._heapq.izip

type: type

doc: izip(iter1 [,iter2 [...]]) --> izip object Return a izip object whose .next() method returns a tuple where the i-th element comes from the i-th iterable argument. The .next() method continues until the shortest iterable in the argument sequence is exhausted and then it raises StopIteration. Works like the zip() function but consumes less memory by returning an iterator instead of a list.

modo.scene.item.util.collections._heapq.merge

type: function

doc: Merge multiple sorted inputs into a single sorted output. Similar to sorted(itertools.chain(*iterables)) but returns a generator, does not pull the data into memory all at once, and assumes that each of the input streams is already sorted (smallest to largest). >>> list(merge([1,3,5,7], [0,2,4,8], [5,10,15,20], [], [25])) [0, 1, 2, 3, 4, 5, 5, 7, 8, 10, 15, 20, 25]

file: .\Lib\heapq.py

modo.scene.item.util.collections._heapq.nlargest

type: function

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, key=key, reverse=True)[:n]

file: .\Lib\heapq.py

modo.scene.item.util.collections._heapq.nsmallest

type: function

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable, key=key)[:n]

file: .\Lib\heapq.py

modo.scene.item.util.collections._heapq.repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

modo.scene.item.util.collections._heapq.tee()

type: builtin_function_or_method

doc: tee(iterable, n=2) --> tuple of n independent iterators.

modo.scene.item.util.collections._iskeyword()

type: builtin_function_or_method

doc: x.__contains__(y) <==> y in x.

modo.scene.item.util.collections._itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.scene.item.util.collections._itemgetter contents:
  • modo.scene.item.util.collections._itemgetter.__call__
  • modo.scene.item.util.collections._itemgetter.__class__
  • modo.scene.item.util.collections._itemgetter.__delattr__
  • modo.scene.item.util.collections._itemgetter.__doc__
  • modo.scene.item.util.collections._itemgetter.__format__
  • modo.scene.item.util.collections._itemgetter.__getattribute__
  • modo.scene.item.util.collections._itemgetter.__hash__
  • modo.scene.item.util.collections._itemgetter.__init__
  • modo.scene.item.util.collections._itemgetter.__new__
  • modo.scene.item.util.collections._itemgetter.__reduce__
  • modo.scene.item.util.collections._itemgetter.__reduce_ex__
  • modo.scene.item.util.collections._itemgetter.__repr__
  • modo.scene.item.util.collections._itemgetter.__setattr__
  • modo.scene.item.util.collections._itemgetter.__sizeof__
  • modo.scene.item.util.collections._itemgetter.__str__
  • modo.scene.item.util.collections._itemgetter.__subclasshook__
modo.scene.item.util.collections._repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.scene.item.util.collections._repeat contents:
  • modo.scene.item.util.collections._repeat.__class__
  • modo.scene.item.util.collections._repeat.__delattr__
  • modo.scene.item.util.collections._repeat.__doc__
  • modo.scene.item.util.collections._repeat.__format__
  • modo.scene.item.util.collections._repeat.__getattribute__
  • modo.scene.item.util.collections._repeat.__hash__
  • modo.scene.item.util.collections._repeat.__init__
  • modo.scene.item.util.collections._repeat.__iter__
  • modo.scene.item.util.collections._repeat.__length_hint__
  • modo.scene.item.util.collections._repeat.__new__
  • modo.scene.item.util.collections._repeat.__reduce__
  • modo.scene.item.util.collections._repeat.__reduce_ex__
  • modo.scene.item.util.collections._repeat.__repr__
  • modo.scene.item.util.collections._repeat.__setattr__
  • modo.scene.item.util.collections._repeat.__sizeof__
  • modo.scene.item.util.collections._repeat.__str__
  • modo.scene.item.util.collections._repeat.__subclasshook__
  • modo.scene.item.util.collections._repeat.next

modo.scene.item.util.collections._repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.scene.item.util.collections._starmap

type: type

doc: starmap(function, sequence) --> starmap object Return an iterator whose values are returned from the function evaluated with a argument tuple taken from the given sequence.

    modo.scene.item.util.collections._starmap contents:
  • modo.scene.item.util.collections._starmap.__class__
  • modo.scene.item.util.collections._starmap.__delattr__
  • modo.scene.item.util.collections._starmap.__doc__
  • modo.scene.item.util.collections._starmap.__format__
  • modo.scene.item.util.collections._starmap.__getattribute__
  • modo.scene.item.util.collections._starmap.__hash__
  • modo.scene.item.util.collections._starmap.__init__
  • modo.scene.item.util.collections._starmap.__iter__
  • modo.scene.item.util.collections._starmap.__new__
  • modo.scene.item.util.collections._starmap.__reduce__
  • modo.scene.item.util.collections._starmap.__reduce_ex__
  • modo.scene.item.util.collections._starmap.__repr__
  • modo.scene.item.util.collections._starmap.__setattr__
  • modo.scene.item.util.collections._starmap.__sizeof__
  • modo.scene.item.util.collections._starmap.__str__
  • modo.scene.item.util.collections._starmap.__subclasshook__
  • modo.scene.item.util.collections._starmap.next

modo.scene.item.util.collections._starmap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.scene.item.util.collections._sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.scene.item.util.collections._sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.scene.item.util.collections._sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.scene.item.util.collections._sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.scene.item.util.collections._sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.item.util.collections._sys.api_version

type: int

modo.scene.item.util.collections._sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.item.util.collections._sys.byteorder

type: str

modo.scene.item.util.collections._sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.scene.item.util.collections._sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.scene.item.util.collections._sys.copyright

type: str

modo.scene.item.util.collections._sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.scene.item.util.collections._sys.dllhandle

type: long

modo.scene.item.util.collections._sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.scene.item.util.collections._sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.scene.item.util.collections._sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.scene.item.util.collections._sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.scene.item.util.collections._sys.exc_type

type: type

doc: Inappropriate argument type.

modo.scene.item.util.collections._sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.scene.item.util.collections._sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.scene.item.util.collections._sys.exec_prefix

type: str

modo.scene.item.util.collections._sys.executable

type: str

modo.scene.item.util.collections._sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.scene.item.util.collections._sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.scene.item.util.collections._sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.scene.item.util.collections._sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.scene.item.util.collections._sys.float_repr_style

type: str

modo.scene.item.util.collections._sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.scene.item.util.collections._sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.scene.item.util.collections._sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.scene.item.util.collections._sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.scene.item.util.collections._sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.scene.item.util.collections._sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.scene.item.util.collections._sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.scene.item.util.collections._sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.scene.item.util.collections._sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.scene.item.util.collections._sys.hexversion

type: int

modo.scene.item.util.collections._sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.scene.item.util.collections._sys.maxint

type: int

modo.scene.item.util.collections._sys.maxsize

type: long

modo.scene.item.util.collections._sys.maxunicode

type: int

modo.scene.item.util.collections._sys.meta_path

type: list

modo.scene.item.util.collections._sys.modules

type: dict

modo.scene.item.util.collections._sys.path

type: list

modo.scene.item.util.collections._sys.path_hooks

type: list

modo.scene.item.util.collections._sys.path_importer_cache

type: dict

modo.scene.item.util.collections._sys.platform

type: str

modo.scene.item.util.collections._sys.prefix

type: str

modo.scene.item.util.collections._sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.scene.item.util.collections._sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.scene.item.util.collections._sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.scene.item.util.collections._sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.scene.item.util.collections._sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.scene.item.util.collections._sys.stderr

type: SESysStdErr

modo.scene.item.util.collections._sys.stdin

type: SESysStdIn

modo.scene.item.util.collections._sys.stdout

type: SESysStdOut

modo.scene.item.util.collections._sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.item.util.collections._sys.version

type: str

modo.scene.item.util.collections._sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.scene.item.util.collections._sys.warnoptions

type: list

modo.scene.item.util.collections._sys.winver

type: str

modo.scene.item.util.collections.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.Counter

type: type

doc: Dict subclass for counting hashable items. Sometimes called a bag or multiset. Elements are stored as dictionary keys and their counts are stored as dictionary values. >>> c = Counter('abcdeabcdabcaba') # count elements from a string >>> c.most_common(3) # three most common elements [('a', 5), ('b', 4), ('c', 3)] >>> sorted(c) # list all unique elements ['a', 'b', 'c', 'd', 'e'] >>> ''.join(sorted(c.elements())) # list elements with repetitions 'aaaaabbbbcccdde' >>> sum(c.values()) # total of all counts 15 >>> c['a'] # count of letter 'a' 5 >>> for elem in 'shazam': # update counts from an iterable ... c[elem] += 1 # by adding 1 to each element's count >>> c['a'] # now there are seven 'a' 7 >>> del c['b'] # remove all 'b' >>> c['b'] # now there are zero 'b' 0 >>> d = Counter('simsalabim') # make another counter >>> c.update(d) # add in the second counter >>> c['a'] # now there are nine 'a' 9 >>> c.clear() # empty the counter >>> c Counter() Note: If a count is set to zero or reduced to zero, it will remain in the counter until the entry is deleted or the counter is cleared: >>> c = Counter('aaabbc') >>> c['b'] -= 2 # reduce the count of 'b' by two >>> c.most_common() # 'b' is still in, but its count is zero [('a', 3), ('c', 1), ('b', 0)]

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.scene.item.util.collections.Counter.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.scene.item.util.collections.Counter.copy(self)

type: instancemethod

doc: Return a shallow copy.

file: .\Lib\collections.py

modo.scene.item.util.collections.Counter.elements(self)

type: instancemethod

doc: Iterator over elements repeating each as many times as its count. >>> c = Counter('ABCABC') >>> sorted(c.elements()) ['A', 'A', 'B', 'B', 'C', 'C'] # Knuth's example for prime factors of 1836: 2**2 * 3**3 * 17**1 >>> prime_factors = Counter({2: 2, 3: 3, 17: 1}) >>> product = 1 >>> for factor in prime_factors.elements(): # loop over factors ... product *= factor # and multiply them >>> product 1836 Note, if an element's count has been set to zero or is a negative number, elements() will ignore it.

file: .\Lib\collections.py

modo.scene.item.util.collections.Counter.fromkeys(cls,iterable,v)

type: instancemethod

file: .\Lib\collections.py

modo.scene.item.util.collections.Counter.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.scene.item.util.collections.Counter.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.scene.item.util.collections.Counter.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.scene.item.util.collections.Counter.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.scene.item.util.collections.Counter.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.scene.item.util.collections.Counter.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.scene.item.util.collections.Counter.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.scene.item.util.collections.Counter.most_common(self,n)

type: instancemethod

doc: List the n most common elements and their counts from the most common to the least. If n is None, then list all element counts. >>> Counter('abcdeabcdabcaba').most_common(3) [('a', 5), ('b', 4), ('c', 3)]

file: .\Lib\collections.py

modo.scene.item.util.collections.Counter.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.scene.item.util.collections.Counter.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.scene.item.util.collections.Counter.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.scene.item.util.collections.Counter.subtract(self,iterable)

type: instancemethod

doc: Like dict.update() but subtracts counts instead of replacing them. Counts can be reduced below zero. Both the inputs and outputs are allowed to contain zero and negative counts. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.subtract('witch') # subtract elements from another iterable >>> c.subtract(Counter('watch')) # subtract elements from another counter >>> c['h'] # 2 in which, minus 1 in witch, minus 1 in watch 0 >>> c['w'] # 1 in which, minus 1 in witch, minus 1 in watch -1

file: .\Lib\collections.py

modo.scene.item.util.collections.Counter.update(self,iterable)

type: instancemethod

doc: Like dict.update() but add counts instead of replacing them. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.update('witch') # add elements from another iterable >>> d = Counter('watch') >>> c.update(d) # add elements from another counter >>> c['h'] # four 'h' in which, witch, and watch 4

file: .\Lib\collections.py

modo.scene.item.util.collections.Counter.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.scene.item.util.collections.Counter.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.scene.item.util.collections.Counter.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.scene.item.util.collections.Counter.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.scene.item.util.collections.defaultdict

type: type

doc: defaultdict(default_factory) --> dict with default factory The default factory is called without arguments to produce a new value when a key is not present, in __getitem__ only. A defaultdict compares equal to a dict with the same items.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.scene.item.util.collections.defaultdict.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.scene.item.util.collections.defaultdict.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D.

modo.scene.item.util.collections.defaultdict.default_factory

type: member_descriptor

doc: Factory for default value called by __missing__().

modo.scene.item.util.collections.defaultdict.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.scene.item.util.collections.defaultdict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.scene.item.util.collections.defaultdict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.scene.item.util.collections.defaultdict.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.scene.item.util.collections.defaultdict.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.scene.item.util.collections.defaultdict.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.scene.item.util.collections.defaultdict.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.scene.item.util.collections.defaultdict.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.scene.item.util.collections.defaultdict.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.scene.item.util.collections.defaultdict.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.scene.item.util.collections.defaultdict.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.scene.item.util.collections.defaultdict.update()

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.scene.item.util.collections.defaultdict.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.scene.item.util.collections.defaultdict.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.scene.item.util.collections.defaultdict.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.scene.item.util.collections.defaultdict.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.scene.item.util.collections.deque

type: type

doc: deque(iterable[, maxlen]) --> deque object Build an ordered collection with optimized access from its endpoints.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.scene.item.util.collections.deque.append()

type: method_descriptor

doc: Add an element to the right side of the deque.

modo.scene.item.util.collections.deque.appendleft()

type: method_descriptor

doc: Add an element to the left side of the deque.

modo.scene.item.util.collections.deque.clear()

type: method_descriptor

doc: Remove all elements from the deque.

modo.scene.item.util.collections.deque.count()

type: method_descriptor

doc: D.count(value) -> integer -- return number of occurrences of value

modo.scene.item.util.collections.deque.extend()

type: method_descriptor

doc: Extend the right side of the deque with elements from the iterable

modo.scene.item.util.collections.deque.extendleft()

type: method_descriptor

doc: Extend the left side of the deque with elements from the iterable

modo.scene.item.util.collections.deque.maxlen

type: getset_descriptor

doc: maximum size of a deque or None if unbounded

modo.scene.item.util.collections.deque.pop()

type: method_descriptor

doc: Remove and return the rightmost element.

modo.scene.item.util.collections.deque.popleft()

type: method_descriptor

doc: Remove and return the leftmost element.

modo.scene.item.util.collections.deque.remove()

type: method_descriptor

doc: D.remove(value) -- remove first occurrence of value.

modo.scene.item.util.collections.deque.reverse()

type: method_descriptor

doc: D.reverse() -- reverse *IN PLACE*

modo.scene.item.util.collections.deque.rotate()

type: method_descriptor

doc: Rotate the deque n steps to the right (default n=1). If n is negative, rotates left.

modo.scene.item.util.collections.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.namedtuple

type: function

doc: Returns a new subclass of tuple with named fields. >>> Point = namedtuple('Point', 'x y') >>> Point.__doc__ # docstring for the new class 'Point(x, y)' >>> p = Point(11, y=22) # instantiate with positional args or keywords >>> p[0] + p[1] # indexable like a plain tuple 33 >>> x, y = p # unpack like a regular tuple >>> x, y (11, 22) >>> p.x + p.y # fields also accessable by name 33 >>> d = p._asdict() # convert to a dictionary >>> d['x'] 11 >>> Point(**d) # convert from a dictionary Point(x=11, y=22) >>> p._replace(x=100) # _replace() is like str.replace() but targets named fields Point(x=100, y=22)

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict

type: type

doc: Dictionary that remembers insertion order

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.scene.item.util.collections.OrderedDict._OrderedDict__marker

type: object

doc: The most base type

modo.scene.item.util.collections.OrderedDict._OrderedDict__update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.scene.item.util.collections.OrderedDict.clear(self)

type: instancemethod

doc: od.clear() -> None. Remove all items from od.

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.copy(self)

type: instancemethod

doc: od.copy() -> a shallow copy of od

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.fromkeys(cls,iterable,value)

type: instancemethod

doc: OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S. If not specified, the value defaults to None.

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.scene.item.util.collections.OrderedDict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.scene.item.util.collections.OrderedDict.items(self)

type: instancemethod

doc: od.items() -> list of (key, value) pairs in od

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.iteritems(self)

type: instancemethod

doc: od.iteritems -> an iterator over the (key, value) pairs in od

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.iterkeys(self)

type: instancemethod

doc: od.iterkeys() -> an iterator over the keys in od

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.itervalues(self)

type: instancemethod

doc: od.itervalues -> an iterator over the values in od

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.keys(self)

type: instancemethod

doc: od.keys() -> list of keys in od

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.pop(self,key,default)

type: instancemethod

doc: od.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.popitem(self,last)

type: instancemethod

doc: od.popitem() -> (k, v), return and remove a (key, value) pair. Pairs are returned in LIFO order if last is true or FIFO order if false.

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.setdefault(self,key,default)

type: instancemethod

doc: od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.scene.item.util.collections.OrderedDict.values(self)

type: instancemethod

doc: od.values() -> list of values in od

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.viewitems(self)

type: instancemethod

doc: od.viewitems() -> a set-like object providing a view on od's items

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.viewkeys(self)

type: instancemethod

doc: od.viewkeys() -> a set-like object providing a view on od's keys

file: .\Lib\collections.py

modo.scene.item.util.collections.OrderedDict.viewvalues(self)

type: instancemethod

doc: od.viewvalues() -> an object providing a view on od's values

file: .\Lib\collections.py

modo.scene.item.util.collections.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.collections.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.item.util.ensureModoItem

type: function

doc: Decorator - ensures that the argument passed as the first parameter to a function is an instance of the modo :class:`Item` class. Should only only be used to decorate methods where the first argument is meant to be an item and ensures that if for any reason an item of either type lx.object.Item or lxu.object.Item gets passed to the method it will get wrapped as an modo.item.Item object before being used.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.item.util.floatEquals

type: function

doc: Test if two floats are equal :returns bool:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.item.util.functools

type: module

doc: functools.py - Tools for working with functions and callable objects

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

modo.scene.item.util.functools.cmp_to_key

type: function

doc: Convert a cmp= function into a key= function

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.scene.item.util.functools.partial

type: type

doc: partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

    modo.scene.item.util.functools.partial contents:
  • modo.scene.item.util.functools.partial.__call__
  • modo.scene.item.util.functools.partial.__class__
  • modo.scene.item.util.functools.partial.__delattr__
  • modo.scene.item.util.functools.partial.__dict__
  • modo.scene.item.util.functools.partial.__doc__
  • modo.scene.item.util.functools.partial.__format__
  • modo.scene.item.util.functools.partial.__getattribute__
  • modo.scene.item.util.functools.partial.__hash__
  • modo.scene.item.util.functools.partial.__init__
  • modo.scene.item.util.functools.partial.__new__
  • modo.scene.item.util.functools.partial.__reduce__
  • modo.scene.item.util.functools.partial.__reduce_ex__
  • modo.scene.item.util.functools.partial.__repr__
  • modo.scene.item.util.functools.partial.__setattr__
  • modo.scene.item.util.functools.partial.__setstate__
  • modo.scene.item.util.functools.partial.__sizeof__
  • modo.scene.item.util.functools.partial.__str__
  • modo.scene.item.util.functools.partial.__subclasshook__
  • modo.scene.item.util.functools.partial.args
  • modo.scene.item.util.functools.partial.func
  • modo.scene.item.util.functools.partial.keywords

modo.scene.item.util.functools.partial.args

type: member_descriptor

doc: tuple of arguments to future partial calls

modo.scene.item.util.functools.partial.func

type: member_descriptor

doc: function object to use in future partial calls

modo.scene.item.util.functools.partial.keywords

type: member_descriptor

doc: dictionary of keyword arguments to future partial calls

modo.scene.item.util.functools.reduce()

type: builtin_function_or_method

doc: reduce(function, sequence[, initial]) -> value Apply a function of two arguments cumulatively to the items of a sequence, from left to right, so as to reduce the sequence to a single value. For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates ((((1+2)+3)+4)+5). If initial is present, it is placed before the items of the sequence in the calculation, and serves as a default when the sequence is empty.

modo.scene.item.util.functools.total_ordering

type: function

doc: Class decorator that fills in missing ordering methods

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.scene.item.util.functools.update_wrapper

type: function

doc: Update a wrapper function to look like the wrapped function wrapper is the function to be updated wrapped is the original function assigned is a tuple naming the attributes assigned directly from the wrapped function to the wrapper function (defaults to functools.WRAPPER_ASSIGNMENTS) updated is a tuple naming the attributes of the wrapper that are updated with the corresponding attribute from the wrapped function (defaults to functools.WRAPPER_UPDATES)

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.scene.item.util.functools.WRAPPER_ASSIGNMENTS

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.item.util.functools.WRAPPER_UPDATES

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.item.util.functools.wraps

type: function

doc: Decorator factory to apply update_wrapper() to a wrapper function Returns a decorator that invokes update_wrapper() with the decorated function as the wrapper argument and the arguments to wraps() as the remaining arguments. Default arguments are as for update_wrapper(). This is a convenience function to simplify applying partial() to update_wrapper().

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.scene.item.util.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.item.util.makeQuickCommand

type: function

doc: Quick way to create a command. Note that a command can only be blessed (registered) once per modo session, so this command will fail when attempting to rebless a command. :param string name: Name that the command will be callable by. Example: cmds.myCommand :param function func: The function that the command should call :param iterable arguments: A sequence of name:defaultvalue pairs to make arguments that will be passed on to the function :param basestring userName: The user name :param basestring description: Summary of the command's purpose :param basestring toolTip: Text that appears when hovering over the button example:: import modo def func_args(mystring, myint): print mystring, myint def func_simple(): print 'simple function, no arguments' modo.util.makeQuickCommand('test.simple', func_simple) modo.util.makeQuickCommand('test.args', func_args, (('mystring', 'mesh021'), ('myint', 23))) lx.eval('test.simple') lx.eval('test.args mesh022 24')

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.item.util.paths

type: function

doc: Access to various system paths. :param basestring key: Specific path to return. Returns all if None. :returns dictionary or string: Dictionary containing all paths or single path as string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.item.util.testGlobalInterpreter

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.item.util.typeToFunc

type: function

doc: selects an item class constructor based on the item type passed as an argument and returns that as a class instantiation 'function' object to call the correct class in methods that eg select by item type or return items. In essence it acts as a sort of clearing house to try to ensure that any recognised but unwrapped items are wrapped with the correct modo.item.xxx type before being returned. example usage:: # get a list of all the light items in a scene where each light in the list is returned as the correctly # wrapped modo version of each light sub-type. import modo scene = modo.Scene() lights = [] for light in scene.ItemList(modo.c.LIGHT_TYPE): func = modo.c.typeToFunc(light.Type()) lights.append(func(light)) # or more succinctly as a list comprehension: lights = [modo.c.typeToFunc(light.Type())(light) for light in scene.ItemList(modo.c.LIGHT_TYPE)]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.item.Vector3

type: type

doc: Vector3 class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.angle(self,other)

type: instancemethod

doc: Returns the angle between this and another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.copy(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.cross(self,other)

type: instancemethod

doc: Returns a new vector with the result of crossing this vector with another

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.distanceBetweenPoints(self,other)

type: instancemethod

doc: Returns the distance between this and another point

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.dot(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.equals(self,other,tolerance)

type: instancemethod

doc: Returns if this vector is equivalent to another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.length(self)

type: instancemethod

doc: Returns the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.mulByMatrixAsPoint(self,other)

type: instancemethod

doc: Transform this point's position by a Matrix4 in place. :param Matrix4 other: Other Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.normal(self)

type: instancemethod

doc: Returns a normalized copy of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.normalize(self)

type: instancemethod

doc: Normalizes this vector in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.rotate(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.rotateByAxisAngle(self,axis,angle)

type: instancemethod

doc: Rotates this vector by a given axis and angle :param Vector3 axis: This axis to rotate about :param float angle: The angle in radians to rotate by

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.rotateByQuat(self,other)

type: instancemethod

doc: Rotate this vector by a quaternion

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.setLength(self,value)

type: instancemethod

doc: Sets the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.item.Vector3.x

type: property

doc: Quick access to the x component of the vector

modo.scene.item.Vector3.y

type: property

doc: Quick access to the y component of the vector

modo.scene.item.Vector3.z

type: property

doc: Quick access to the z component of the vector

modo.scene.Scene

type: type

doc: The main scene class. Takes an optional lx.object.Scene object as an argument. If none is provided (the default) then the currently selected scene is used which will mostly be the general case. The module function :func:`sceneList` makes use of the scene parameter to return a list of open scenes as modo.scene.Scene objects. :param scene: Optional scene object to wrap. :type scene: lx.object.Scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene._allItems(self)

type: instancemethod

doc: Utility function to get all items of a scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene._Scene__ItemAdd(self,groupType)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene._Scene__setupTextureLayerType(self,newItem)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.actors

type: property

doc: Returns a list of all actors in the scene :getter: Returns a list of Actor objects found in this scene :rtype: list

modo.scene.Scene.addActor(self,name,items,makeActive)

type: instancemethod

doc: Add a new actor to the scene :returns modo.item.Actor: Actor item object :param basestring name: optional name :param list items: list of items for the actor to contain

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.addCamera(self,name)

type: instancemethod

doc: Add a new camera item to the scene :returns: camera item :rtype: modo.item.Camera :param name: optional name for the camera. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.addGroup(self,name,gtype)

type: instancemethod

doc: Add a new group item to the scene :returns: group item :rtype: modo.item.Group :param name: optional name for the group item. :type name: basestring :param gtype: optional group type, can be one of the default group types ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader') or any other string to create a custom group type. Default is an empty string which creates a 'Genera' group type. :type gtype: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.addItem(self,itype,name)

type: instancemethod

doc: Add a new item to the scene :returns: item :rtype: modo.item.item :param itype: item type :type itype: modo.Constant :param name: optional name for the item. :type name: basestring :raises TypeError: When failing

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.addJointLocator(self,name,parent)

type: instancemethod

doc: Adds a new joint to the scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.addMaterial(self,matType,name,index)

type: instancemethod

doc: Adds a new material to the scene :param modo.c.MATERIAL_* matType: Type of material to create :param name: Optional name for the material :returns Item: The material item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.addMesh(self,name)

type: instancemethod

doc: Add a new mesh item to the scene :returns: mesh item :rtype: modo.item.Mesh :param name: optional name for the mesh. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.addRenderPassGroup(self,name)

type: instancemethod

doc: Add a render pass group to the scene :returns: render pass group. :rtype: modo.item.RenderPassGroup :param name: optional name for the render pass group. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.camera(self,cam)

type: instancemethod

doc: Returns a camera item in the scene. The supplied argument can be either a string (camera ID or name) or an integer (camera index in the scene's collection of cameras) :param cam: the camera :type cam: basestring or int :returns: camera item :rtype: modo.item.Camera

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.cameraCount

type: property

doc: Number of cameras in the scene. :getter: Returns the number of camera items. :rtype: int

modo.scene.Scene.cameras

type: property

doc: Returns a list of all the camera items in the scene as modo.item.Camera objects. :getter: Returns a list of the camera items in the scene. :rtype: list of modo.item.Camera

modo.scene.Scene.currentRange

type: property

doc: Set or read the current frame range start and end frame value should be passed in as a tuple. :setter: Sets the range :param frange: frame range - a tuple of ints (start, end). :type frange: tuple :Getter: Returns the start and end frames. :rtype: tuple :exception ValueError: if supplied start frame is higher than end frame.

modo.scene.Scene.deformers(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.deselect(self,itemObj)

type: instancemethod

doc: Deselect an item. :param itemObj: the item to deselect. Clears the entire selection if None :type itemObj: basestring (item name or ID) or instance of either lx.object.Item or modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.duplicateItem(self,item,instance)

type: instancemethod

doc: Creates and returns a duplicate of the passed item :returns item: Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.filename

type: property

doc: File path of the scene. :getter: Returns the file path of the scene or 'None' if not yet saved. :rtype: basestring or None

modo.scene.Scene.fps

type: property

doc: Scene frames per second. .. note:: There is no way to set the fps value from the Python API for any scene other than the currently selected one. Therefore, for any other scene the property will be read only and attempts to write to it will throw an AttributeError. | :getter: Returns the Frames Per Second :rtype: float :setter: Sets the Frames Per Second :param fps: Scene frames per second. :type fps: float :raises: AttributeError

modo.scene.Scene.getGroups(self,gtype)

type: instancemethod

doc: Returns all groups of the given kind :param gtype: optional group type, can be one of the default group types ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader') or any other string to create a custom group type. Default is an empty string which creates a 'Genera' group type. You can also pass a list of multiple group types. :returns list: List of groups matching the type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.groups

type: property

doc: Returns a list of all the group items in the scene as modo.item.Group objects. :getter: Returns a list of the group items in the scene. :rtype: list of modo.item.Group

modo.scene.Scene.item(self,name)

type: instancemethod

doc: Look up item by name :param string item: Name to look for :returns item: Found item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.itemCount(self,itype)

type: instancemethod

doc: The number of items of a specified type in the scene. :param itype: type of the items. :type itype: int or basestring :returns: the number of items of the specified type in the scene. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.items(self,itype,name,superType)

type: instancemethod

doc: List of items of the specified type in the scene. :param itype: the item type. :type itype: :param basestring name: Optionally filter result by this text. Can use * and ? wildcards for globbing. :param bool superType: If True, all items that have 'itype' as superType are listed. Else, only items of specifically that type are returned. :returns: list of the items of the specified type in the scene. If itype is None, all items in the scene are returned. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.iterItems(self,itype,name,superType)

type: instancemethod

doc: Same as items(), but returns a generator object.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.lightCount

type: property

doc: Number of lights in the scene. :getter: Returns the number of light items. :rtype: int

modo.scene.Scene.locators

type: property

modo.scene.Scene.meshCount

type: property

doc: Number of mesh items in the scene. :getter: Returns the number of mesh items. :rtype: int

modo.scene.Scene.meshes

type: property

doc: Returns a list of all the mesh items in the scene as modo.item.Mesh objects. :getter: Returns a list of the mesh items in the scene. :rtype: list of modo.item.Mesh

modo.scene.Scene.name

type: property

doc: Friendly name of the scene. :getter: Returns the name of the scene. :rtype: basestring

modo.scene.Scene.removeItems(self,itm,children)

type: instancemethod

doc: :param Item: Item to remove from the scene :param bool children: If True, all found children are deleted also

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.renderCamera

type: property

doc: Get & set the scene's current render camera :setter: Set the scene's current render camera :param camera: the camera item to set as the current render camera. :type camera: lx.object.Item of type 'Camera' :getter: Returns the current render camera. :rtype: modo.Item.Camera

modo.scene.Scene.renderItem

type: property

doc: :getter: Returns the first found render item of the scene :rtype: Item

modo.scene.Scene.renderPassGroups

type: property

doc: Returns a list of all the render pass group items in the scene as modo.item.RenderPassGroup objects. :getter: Returns a list of the render pass group items in the scene. :rtype: list of modo.item.Group

modo.scene.Scene.sceneItem

type: property

doc: The scene's 'scene item' :getter: Returns the scene's scene item. :rtype: lxdt.item.Item (type lx.symbol.sITYPE_SCENE)

modo.scene.Scene.sceneRange

type: property

doc: Set or read the scene's frame range start and end frame value should be passed in as a tuple. :setter: Sets the range :param frange: frame range - a tuple of ints (start, end). :type frange: tuple :getter: Returns the start and end frames. :rtype: tuple :exception ValueError: if supplied start frame is higher than end frame.

modo.scene.Scene.select(self,itemObj,add)

type: instancemethod

doc: :param itemObj: the item to select. :type item: basestring (item name or ID) or instance of either lx.object.Item or modo.item.Item :param add: whether to add to the current selection, False replaces the current selection. :type add: bool Note:: To clear the selection of the scene, please use deselect() instead.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.Scene.selected

type: property

doc: Selected items in the scene. :getter: Returns the selected items :rtype: list

modo.scene.Scene.selectedByType(self,itype,superType)

type: instancemethod

doc: Returns the selected items of a specific type as modo.item.Item objects. :param itype: item type to filter on. :type itype: int or string :return: selcted items of specified type. :param bool superType: If True, all items derived fom itype are listed. Otherwise only items of the exact type of itype. :rtype: list of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.sceneList

type: function

doc: Get a list of all the currently open scenes. :returns: Collection of currently open scenes as modo.scene.Scene objects. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.util.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.scene.util.collections

type: module

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.scene.util.collections._abcoll

type: module

doc: Abstract Base Classes (ABCs) for collections, according to PEP 3119. DON'T USE THIS MODULE DIRECTLY! The classes here should be imported via collections; they are defined here only to alleviate certain bootstrapping issues. Unit tests are in test_collections.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll._hasattr

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.scene.util.collections._abcoll.ABCMeta

type: type

doc: Metaclass for defining Abstract Base Classes (ABCs). Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as 'virtual subclasses' -- these and their descendants will be considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won't show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via super()).

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\abc.pyc

    modo.scene.util.collections._abcoll.ABCMeta contents:
  • modo.scene.util.collections._abcoll.ABCMeta.__base__
  • modo.scene.util.collections._abcoll.ABCMeta.__bases__
  • modo.scene.util.collections._abcoll.ABCMeta.__basicsize__
  • modo.scene.util.collections._abcoll.ABCMeta.__call__
  • modo.scene.util.collections._abcoll.ABCMeta.__class__
  • modo.scene.util.collections._abcoll.ABCMeta.__delattr__
  • modo.scene.util.collections._abcoll.ABCMeta.__dict__
  • modo.scene.util.collections._abcoll.ABCMeta.__dictoffset__
  • modo.scene.util.collections._abcoll.ABCMeta.__doc__
  • modo.scene.util.collections._abcoll.ABCMeta.__eq__
  • modo.scene.util.collections._abcoll.ABCMeta.__flags__
  • modo.scene.util.collections._abcoll.ABCMeta.__format__
  • modo.scene.util.collections._abcoll.ABCMeta.__ge__
  • modo.scene.util.collections._abcoll.ABCMeta.__getattribute__
  • modo.scene.util.collections._abcoll.ABCMeta.__gt__
  • modo.scene.util.collections._abcoll.ABCMeta.__hash__
  • modo.scene.util.collections._abcoll.ABCMeta.__init__
  • modo.scene.util.collections._abcoll.ABCMeta.__instancecheck__
  • modo.scene.util.collections._abcoll.ABCMeta.__itemsize__
  • modo.scene.util.collections._abcoll.ABCMeta.__le__
  • modo.scene.util.collections._abcoll.ABCMeta.__lt__
  • modo.scene.util.collections._abcoll.ABCMeta.__module__
  • modo.scene.util.collections._abcoll.ABCMeta.__mro__
  • modo.scene.util.collections._abcoll.ABCMeta.__name__
  • modo.scene.util.collections._abcoll.ABCMeta.__ne__
  • modo.scene.util.collections._abcoll.ABCMeta.__new__
  • modo.scene.util.collections._abcoll.ABCMeta.__reduce__
  • modo.scene.util.collections._abcoll.ABCMeta.__reduce_ex__
  • modo.scene.util.collections._abcoll.ABCMeta.__repr__
  • modo.scene.util.collections._abcoll.ABCMeta.__setattr__
  • modo.scene.util.collections._abcoll.ABCMeta.__sizeof__
  • modo.scene.util.collections._abcoll.ABCMeta.__str__
  • modo.scene.util.collections._abcoll.ABCMeta.__subclasscheck__
  • modo.scene.util.collections._abcoll.ABCMeta.__subclasses__
  • modo.scene.util.collections._abcoll.ABCMeta.__subclasshook__
  • modo.scene.util.collections._abcoll.ABCMeta.__weakrefoffset__
  • modo.scene.util.collections._abcoll.ABCMeta._abc_invalidation_counter
  • modo.scene.util.collections._abcoll.ABCMeta._dump_registry
  • modo.scene.util.collections._abcoll.ABCMeta.mro
  • modo.scene.util.collections._abcoll.ABCMeta.register

modo.scene.util.collections._abcoll.ABCMeta._abc_invalidation_counter

type: int

modo.scene.util.collections._abcoll.ABCMeta._dump_registry(cls,file)

type: instancemethod

doc: Debug helper to print the ABC registry.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.scene.util.collections._abcoll.ABCMeta.mro()

type: method_descriptor

doc: mro() -> list return a type's method resolution order

modo.scene.util.collections._abcoll.ABCMeta.register(cls,subclass)

type: instancemethod

doc: Register a virtual subclass of an ABC.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.scene.util.collections._abcoll.abstractmethod

type: function

doc: A decorator indicating abstract methods. Requires that the metaclass is ABCMeta or derived from it. A class that has a metaclass derived from ABCMeta cannot be instantiated unless all of its abstract methods are overridden. The abstract methods can be called using any of the normal 'super' call mechanisms. Usage: class C: __metaclass__ = ABCMeta @abstractmethod def my_abstract_method(self, ...): ...

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.scene.util.collections._abcoll.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._abcoll.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.scene.util.collections._abcoll.sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.scene.util.collections._abcoll.sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.scene.util.collections._abcoll.sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.scene.util.collections._abcoll.sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.util.collections._abcoll.sys.api_version

type: int

modo.scene.util.collections._abcoll.sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.util.collections._abcoll.sys.byteorder

type: str

modo.scene.util.collections._abcoll.sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.scene.util.collections._abcoll.sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.scene.util.collections._abcoll.sys.copyright

type: str

modo.scene.util.collections._abcoll.sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.scene.util.collections._abcoll.sys.dllhandle

type: long

modo.scene.util.collections._abcoll.sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.scene.util.collections._abcoll.sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.scene.util.collections._abcoll.sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.scene.util.collections._abcoll.sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.scene.util.collections._abcoll.sys.exc_type

type: type

doc: Inappropriate argument type.

modo.scene.util.collections._abcoll.sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.scene.util.collections._abcoll.sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.scene.util.collections._abcoll.sys.exec_prefix

type: str

modo.scene.util.collections._abcoll.sys.executable

type: str

modo.scene.util.collections._abcoll.sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.scene.util.collections._abcoll.sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.scene.util.collections._abcoll.sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.scene.util.collections._abcoll.sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.scene.util.collections._abcoll.sys.float_repr_style

type: str

modo.scene.util.collections._abcoll.sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.scene.util.collections._abcoll.sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.scene.util.collections._abcoll.sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.scene.util.collections._abcoll.sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.scene.util.collections._abcoll.sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.scene.util.collections._abcoll.sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.scene.util.collections._abcoll.sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.scene.util.collections._abcoll.sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.scene.util.collections._abcoll.sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.scene.util.collections._abcoll.sys.hexversion

type: int

modo.scene.util.collections._abcoll.sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.scene.util.collections._abcoll.sys.maxint

type: int

modo.scene.util.collections._abcoll.sys.maxsize

type: long

modo.scene.util.collections._abcoll.sys.maxunicode

type: int

modo.scene.util.collections._abcoll.sys.meta_path

type: list

modo.scene.util.collections._abcoll.sys.modules

type: dict

modo.scene.util.collections._abcoll.sys.path

type: list

modo.scene.util.collections._abcoll.sys.path_hooks

type: list

modo.scene.util.collections._abcoll.sys.path_importer_cache

type: dict

modo.scene.util.collections._abcoll.sys.platform

type: str

modo.scene.util.collections._abcoll.sys.prefix

type: str

modo.scene.util.collections._abcoll.sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.scene.util.collections._abcoll.sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.scene.util.collections._abcoll.sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.scene.util.collections._abcoll.sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.scene.util.collections._abcoll.sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.scene.util.collections._abcoll.sys.stderr

type: SESysStdErr

modo.scene.util.collections._abcoll.sys.stdin

type: SESysStdIn

modo.scene.util.collections._abcoll.sys.stdout

type: SESysStdOut

modo.scene.util.collections._abcoll.sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.util.collections._abcoll.sys.version

type: str

modo.scene.util.collections._abcoll.sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.scene.util.collections._abcoll.sys.warnoptions

type: list

modo.scene.util.collections._abcoll.sys.winver

type: str

modo.scene.util.collections._abcoll.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections._chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.scene.util.collections._chain contents:
  • modo.scene.util.collections._chain.__class__
  • modo.scene.util.collections._chain.__delattr__
  • modo.scene.util.collections._chain.__doc__
  • modo.scene.util.collections._chain.__format__
  • modo.scene.util.collections._chain.__getattribute__
  • modo.scene.util.collections._chain.__hash__
  • modo.scene.util.collections._chain.__init__
  • modo.scene.util.collections._chain.__iter__
  • modo.scene.util.collections._chain.__new__
  • modo.scene.util.collections._chain.__reduce__
  • modo.scene.util.collections._chain.__reduce_ex__
  • modo.scene.util.collections._chain.__repr__
  • modo.scene.util.collections._chain.__setattr__
  • modo.scene.util.collections._chain.__sizeof__
  • modo.scene.util.collections._chain.__str__
  • modo.scene.util.collections._chain.__subclasshook__
  • modo.scene.util.collections._chain.from_iterable
  • modo.scene.util.collections._chain.next

modo.scene.util.collections._chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.scene.util.collections._chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.scene.util.collections._get_ident()

type: builtin_function_or_method

doc: get_ident() -> integer Return a non-zero integer that uniquely identifies the current thread amongst other threads that exist simultaneously. This may be used to identify per-thread resources. Even though on some platforms threads identities may appear to be allocated consecutive numbers starting at 1, this behavior should not be relied upon, and the number should be seen purely as a magic cookie. A thread's identity may be reused for another thread after it exits.

modo.scene.util.collections._heapq

type: module

doc: Heap queue algorithm (a.k.a. priority queue). Heaps are arrays for which a[k] <= a[2*k+1] and a[k] <= a[2*k+2] for all k, counting elements from 0. For the sake of comparison, non-existing elements are considered to be infinite. The interesting property of a heap is that a[0] is always its smallest element. Usage: heap = [] # creates an empty heap heappush(heap, item) # pushes a new item on the heap item = heappop(heap) # pops the smallest item from the heap item = heap[0] # smallest item on the heap without popping it heapify(x) # transforms list into a heap, in-place, in linear time item = heapreplace(heap, item) # pops and returns smallest item, and adds # new item; the heap size is unchanged Our API differs from textbook heap algorithms as follows: - We use 0-based indexing. This makes the relationship between the index for a node and the indexes for its children slightly less obvious, but is more suitable since Python uses 0-based indexing. - Our heappop() method returns the smallest item, not the largest. These two make it possible to view the heap as a regular Python list without surprises: heap[0] is the smallest item, and heap.sort() maintains the heap invariant!

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\heapq.pyc

modo.scene.util.collections._heapq._nlargest()

type: builtin_function_or_method

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, reverse=True)[:n]

modo.scene.util.collections._heapq._nsmallest()

type: builtin_function_or_method

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable)[:n]

modo.scene.util.collections._heapq._siftdown

type: function

file: .\Lib\heapq.py

modo.scene.util.collections._heapq._siftup

type: function

file: .\Lib\heapq.py

modo.scene.util.collections._heapq.bisect

type: module

doc: Bisection algorithms.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\bisect.pyc

modo.scene.util.collections._heapq.bisect.bisect()

type: builtin_function_or_method

doc: Alias for bisect_right().

modo.scene.util.collections._heapq.bisect.bisect_left()

type: builtin_function_or_method

doc: bisect_left(a, x[, lo[, hi]]) -> index Return the index where to insert item x in list a, assuming a is sorted. The return value i is such that all e in a[:i] have e < x, and all e in a[i:] have e >= x. So if x already appears in the list, i points just before the leftmost x already there. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.scene.util.collections._heapq.bisect.bisect_right()

type: builtin_function_or_method

doc: bisect_right(a, x[, lo[, hi]]) -> index Return the index where to insert item x in list a, assuming a is sorted. The return value i is such that all e in a[:i] have e <= x, and all e in a[i:] have e > x. So if x already appears in the list, i points just beyond the rightmost x already there Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.scene.util.collections._heapq.bisect.insort()

type: builtin_function_or_method

doc: Alias for insort_right().

modo.scene.util.collections._heapq.bisect.insort_left()

type: builtin_function_or_method

doc: insort_left(a, x[, lo[, hi]]) Insert item x in list a, and keep it sorted assuming a is sorted. If x is already in a, insert it to the left of the leftmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.scene.util.collections._heapq.bisect.insort_right()

type: builtin_function_or_method

doc: insort_right(a, x[, lo[, hi]]) Insert item x in list a, and keep it sorted assuming a is sorted. If x is already in a, insert it to the right of the rightmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.scene.util.collections._heapq.chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.scene.util.collections._heapq.chain contents:
  • modo.scene.util.collections._heapq.chain.__class__
  • modo.scene.util.collections._heapq.chain.__delattr__
  • modo.scene.util.collections._heapq.chain.__doc__
  • modo.scene.util.collections._heapq.chain.__format__
  • modo.scene.util.collections._heapq.chain.__getattribute__
  • modo.scene.util.collections._heapq.chain.__hash__
  • modo.scene.util.collections._heapq.chain.__init__
  • modo.scene.util.collections._heapq.chain.__iter__
  • modo.scene.util.collections._heapq.chain.__new__
  • modo.scene.util.collections._heapq.chain.__reduce__
  • modo.scene.util.collections._heapq.chain.__reduce_ex__
  • modo.scene.util.collections._heapq.chain.__repr__
  • modo.scene.util.collections._heapq.chain.__setattr__
  • modo.scene.util.collections._heapq.chain.__sizeof__
  • modo.scene.util.collections._heapq.chain.__str__
  • modo.scene.util.collections._heapq.chain.__subclasshook__
  • modo.scene.util.collections._heapq.chain.from_iterable
  • modo.scene.util.collections._heapq.chain.next

modo.scene.util.collections._heapq.chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.scene.util.collections._heapq.chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.scene.util.collections._heapq.cmp_lt

type: function

file: .\Lib\heapq.py

modo.scene.util.collections._heapq.count

type: type

doc: count(start=0, step=1) --> count object Return a count object whose .next() method returns consecutive values. Equivalent to: def count(firstval=0, step=1): x = firstval while 1: yield x x += step

    modo.scene.util.collections._heapq.count contents:
  • modo.scene.util.collections._heapq.count.__class__
  • modo.scene.util.collections._heapq.count.__delattr__
  • modo.scene.util.collections._heapq.count.__doc__
  • modo.scene.util.collections._heapq.count.__format__
  • modo.scene.util.collections._heapq.count.__getattribute__
  • modo.scene.util.collections._heapq.count.__hash__
  • modo.scene.util.collections._heapq.count.__init__
  • modo.scene.util.collections._heapq.count.__iter__
  • modo.scene.util.collections._heapq.count.__new__
  • modo.scene.util.collections._heapq.count.__reduce__
  • modo.scene.util.collections._heapq.count.__reduce_ex__
  • modo.scene.util.collections._heapq.count.__repr__
  • modo.scene.util.collections._heapq.count.__setattr__
  • modo.scene.util.collections._heapq.count.__sizeof__
  • modo.scene.util.collections._heapq.count.__str__
  • modo.scene.util.collections._heapq.count.__subclasshook__
  • modo.scene.util.collections._heapq.count.next

modo.scene.util.collections._heapq.count.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.scene.util.collections._heapq.heapify()

type: builtin_function_or_method

doc: Transform list into a heap, in-place, in O(len(heap)) time.

modo.scene.util.collections._heapq.heappop()

type: builtin_function_or_method

doc: Pop the smallest item off the heap, maintaining the heap invariant.

modo.scene.util.collections._heapq.heappush()

type: builtin_function_or_method

doc: Push item onto heap, maintaining the heap invariant.

modo.scene.util.collections._heapq.heappushpop()

type: builtin_function_or_method

doc: Push item on the heap, then pop and return the smallest item from the heap. The combined action runs more efficiently than heappush() followed by a separate call to heappop().

modo.scene.util.collections._heapq.heapreplace()

type: builtin_function_or_method

doc: Pop and return the current smallest value, and add the new item. This is more efficient than heappop() followed by heappush(), and can be more appropriate when using a fixed-size heap. Note that the value returned may be larger than item! That constrains reasonable uses of this routine unless written as part of a conditional replacement: if item > heap[0]: item = heapreplace(heap, item)

modo.scene.util.collections._heapq.imap

type: type

doc: imap(func, *iterables) --> imap object Make an iterator that computes the function using arguments from each of the iterables. Like map() except that it returns an iterator instead of a list and that it stops when the shortest iterable is exhausted instead of filling in None for shorter iterables.

    modo.scene.util.collections._heapq.imap contents:
  • modo.scene.util.collections._heapq.imap.__class__
  • modo.scene.util.collections._heapq.imap.__delattr__
  • modo.scene.util.collections._heapq.imap.__doc__
  • modo.scene.util.collections._heapq.imap.__format__
  • modo.scene.util.collections._heapq.imap.__getattribute__
  • modo.scene.util.collections._heapq.imap.__hash__
  • modo.scene.util.collections._heapq.imap.__init__
  • modo.scene.util.collections._heapq.imap.__iter__
  • modo.scene.util.collections._heapq.imap.__new__
  • modo.scene.util.collections._heapq.imap.__reduce__
  • modo.scene.util.collections._heapq.imap.__reduce_ex__
  • modo.scene.util.collections._heapq.imap.__repr__
  • modo.scene.util.collections._heapq.imap.__setattr__
  • modo.scene.util.collections._heapq.imap.__sizeof__
  • modo.scene.util.collections._heapq.imap.__str__
  • modo.scene.util.collections._heapq.imap.__subclasshook__
  • modo.scene.util.collections._heapq.imap.next

modo.scene.util.collections._heapq.imap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.scene.util.collections._heapq.islice

type: type

doc: islice(iterable, [start,] stop [, step]) --> islice object Return an iterator whose next() method returns selected values from an iterable. If start is specified, will skip all preceding elements; otherwise, start defaults to zero. Step defaults to one. If specified as another value, step determines how many values are skipped between successive calls. Works like a slice() on a list but returns an iterator.

    modo.scene.util.collections._heapq.islice contents:
  • modo.scene.util.collections._heapq.islice.__class__
  • modo.scene.util.collections._heapq.islice.__delattr__
  • modo.scene.util.collections._heapq.islice.__doc__
  • modo.scene.util.collections._heapq.islice.__format__
  • modo.scene.util.collections._heapq.islice.__getattribute__
  • modo.scene.util.collections._heapq.islice.__hash__
  • modo.scene.util.collections._heapq.islice.__init__
  • modo.scene.util.collections._heapq.islice.__iter__
  • modo.scene.util.collections._heapq.islice.__new__
  • modo.scene.util.collections._heapq.islice.__reduce__
  • modo.scene.util.collections._heapq.islice.__reduce_ex__
  • modo.scene.util.collections._heapq.islice.__repr__
  • modo.scene.util.collections._heapq.islice.__setattr__
  • modo.scene.util.collections._heapq.islice.__sizeof__
  • modo.scene.util.collections._heapq.islice.__str__
  • modo.scene.util.collections._heapq.islice.__subclasshook__
  • modo.scene.util.collections._heapq.islice.next

modo.scene.util.collections._heapq.islice.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.scene.util.collections._heapq.itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.scene.util.collections._heapq.itemgetter contents:
  • modo.scene.util.collections._heapq.itemgetter.__call__
  • modo.scene.util.collections._heapq.itemgetter.__class__
  • modo.scene.util.collections._heapq.itemgetter.__delattr__
  • modo.scene.util.collections._heapq.itemgetter.__doc__
  • modo.scene.util.collections._heapq.itemgetter.__format__
  • modo.scene.util.collections._heapq.itemgetter.__getattribute__
  • modo.scene.util.collections._heapq.itemgetter.__hash__
  • modo.scene.util.collections._heapq.itemgetter.__init__
  • modo.scene.util.collections._heapq.itemgetter.__new__
  • modo.scene.util.collections._heapq.itemgetter.__reduce__
  • modo.scene.util.collections._heapq.itemgetter.__reduce_ex__
  • modo.scene.util.collections._heapq.itemgetter.__repr__
  • modo.scene.util.collections._heapq.itemgetter.__setattr__
  • modo.scene.util.collections._heapq.itemgetter.__sizeof__
  • modo.scene.util.collections._heapq.itemgetter.__str__
  • modo.scene.util.collections._heapq.itemgetter.__subclasshook__
modo.scene.util.collections._heapq.izip

type: type

doc: izip(iter1 [,iter2 [...]]) --> izip object Return a izip object whose .next() method returns a tuple where the i-th element comes from the i-th iterable argument. The .next() method continues until the shortest iterable in the argument sequence is exhausted and then it raises StopIteration. Works like the zip() function but consumes less memory by returning an iterator instead of a list.

    modo.scene.util.collections._heapq.izip contents:
  • modo.scene.util.collections._heapq.izip.__class__
  • modo.scene.util.collections._heapq.izip.__delattr__
  • modo.scene.util.collections._heapq.izip.__doc__
  • modo.scene.util.collections._heapq.izip.__format__
  • modo.scene.util.collections._heapq.izip.__getattribute__
  • modo.scene.util.collections._heapq.izip.__hash__
  • modo.scene.util.collections._heapq.izip.__init__
  • modo.scene.util.collections._heapq.izip.__iter__
  • modo.scene.util.collections._heapq.izip.__new__
  • modo.scene.util.collections._heapq.izip.__reduce__
  • modo.scene.util.collections._heapq.izip.__reduce_ex__
  • modo.scene.util.collections._heapq.izip.__repr__
  • modo.scene.util.collections._heapq.izip.__setattr__
  • modo.scene.util.collections._heapq.izip.__sizeof__
  • modo.scene.util.collections._heapq.izip.__str__
  • modo.scene.util.collections._heapq.izip.__subclasshook__
  • modo.scene.util.collections._heapq.izip.next

modo.scene.util.collections._heapq.izip.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.scene.util.collections._heapq.merge

type: function

doc: Merge multiple sorted inputs into a single sorted output. Similar to sorted(itertools.chain(*iterables)) but returns a generator, does not pull the data into memory all at once, and assumes that each of the input streams is already sorted (smallest to largest). >>> list(merge([1,3,5,7], [0,2,4,8], [5,10,15,20], [], [25])) [0, 1, 2, 3, 4, 5, 5, 7, 8, 10, 15, 20, 25]

file: .\Lib\heapq.py

modo.scene.util.collections._heapq.nlargest

type: function

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, key=key, reverse=True)[:n]

file: .\Lib\heapq.py

modo.scene.util.collections._heapq.nsmallest

type: function

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable, key=key)[:n]

file: .\Lib\heapq.py

modo.scene.util.collections._heapq.repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.scene.util.collections._heapq.repeat contents:
  • modo.scene.util.collections._heapq.repeat.__class__
  • modo.scene.util.collections._heapq.repeat.__delattr__
  • modo.scene.util.collections._heapq.repeat.__doc__
  • modo.scene.util.collections._heapq.repeat.__format__
  • modo.scene.util.collections._heapq.repeat.__getattribute__
  • modo.scene.util.collections._heapq.repeat.__hash__
  • modo.scene.util.collections._heapq.repeat.__init__
  • modo.scene.util.collections._heapq.repeat.__iter__
  • modo.scene.util.collections._heapq.repeat.__length_hint__
  • modo.scene.util.collections._heapq.repeat.__new__
  • modo.scene.util.collections._heapq.repeat.__reduce__
  • modo.scene.util.collections._heapq.repeat.__reduce_ex__
  • modo.scene.util.collections._heapq.repeat.__repr__
  • modo.scene.util.collections._heapq.repeat.__setattr__
  • modo.scene.util.collections._heapq.repeat.__sizeof__
  • modo.scene.util.collections._heapq.repeat.__str__
  • modo.scene.util.collections._heapq.repeat.__subclasshook__
  • modo.scene.util.collections._heapq.repeat.next

modo.scene.util.collections._heapq.repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.scene.util.collections._heapq.tee()

type: builtin_function_or_method

doc: tee(iterable, n=2) --> tuple of n independent iterators.

modo.scene.util.collections._iskeyword()

type: builtin_function_or_method

doc: x.__contains__(y) <==> y in x.

modo.scene.util.collections._itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.scene.util.collections._itemgetter contents:
  • modo.scene.util.collections._itemgetter.__call__
  • modo.scene.util.collections._itemgetter.__class__
  • modo.scene.util.collections._itemgetter.__delattr__
  • modo.scene.util.collections._itemgetter.__doc__
  • modo.scene.util.collections._itemgetter.__format__
  • modo.scene.util.collections._itemgetter.__getattribute__
  • modo.scene.util.collections._itemgetter.__hash__
  • modo.scene.util.collections._itemgetter.__init__
  • modo.scene.util.collections._itemgetter.__new__
  • modo.scene.util.collections._itemgetter.__reduce__
  • modo.scene.util.collections._itemgetter.__reduce_ex__
  • modo.scene.util.collections._itemgetter.__repr__
  • modo.scene.util.collections._itemgetter.__setattr__
  • modo.scene.util.collections._itemgetter.__sizeof__
  • modo.scene.util.collections._itemgetter.__str__
  • modo.scene.util.collections._itemgetter.__subclasshook__
modo.scene.util.collections._repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.scene.util.collections._repeat contents:
  • modo.scene.util.collections._repeat.__class__
  • modo.scene.util.collections._repeat.__delattr__
  • modo.scene.util.collections._repeat.__doc__
  • modo.scene.util.collections._repeat.__format__
  • modo.scene.util.collections._repeat.__getattribute__
  • modo.scene.util.collections._repeat.__hash__
  • modo.scene.util.collections._repeat.__init__
  • modo.scene.util.collections._repeat.__iter__
  • modo.scene.util.collections._repeat.__length_hint__
  • modo.scene.util.collections._repeat.__new__
  • modo.scene.util.collections._repeat.__reduce__
  • modo.scene.util.collections._repeat.__reduce_ex__
  • modo.scene.util.collections._repeat.__repr__
  • modo.scene.util.collections._repeat.__setattr__
  • modo.scene.util.collections._repeat.__sizeof__
  • modo.scene.util.collections._repeat.__str__
  • modo.scene.util.collections._repeat.__subclasshook__
  • modo.scene.util.collections._repeat.next

modo.scene.util.collections._repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.scene.util.collections._starmap

type: type

doc: starmap(function, sequence) --> starmap object Return an iterator whose values are returned from the function evaluated with a argument tuple taken from the given sequence.

    modo.scene.util.collections._starmap contents:
  • modo.scene.util.collections._starmap.__class__
  • modo.scene.util.collections._starmap.__delattr__
  • modo.scene.util.collections._starmap.__doc__
  • modo.scene.util.collections._starmap.__format__
  • modo.scene.util.collections._starmap.__getattribute__
  • modo.scene.util.collections._starmap.__hash__
  • modo.scene.util.collections._starmap.__init__
  • modo.scene.util.collections._starmap.__iter__
  • modo.scene.util.collections._starmap.__new__
  • modo.scene.util.collections._starmap.__reduce__
  • modo.scene.util.collections._starmap.__reduce_ex__
  • modo.scene.util.collections._starmap.__repr__
  • modo.scene.util.collections._starmap.__setattr__
  • modo.scene.util.collections._starmap.__sizeof__
  • modo.scene.util.collections._starmap.__str__
  • modo.scene.util.collections._starmap.__subclasshook__
  • modo.scene.util.collections._starmap.next

modo.scene.util.collections._starmap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.scene.util.collections._sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.scene.util.collections._sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.scene.util.collections._sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.scene.util.collections._sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.scene.util.collections._sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.util.collections._sys.api_version

type: int

modo.scene.util.collections._sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.util.collections._sys.byteorder

type: str

modo.scene.util.collections._sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.scene.util.collections._sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.scene.util.collections._sys.copyright

type: str

modo.scene.util.collections._sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.scene.util.collections._sys.dllhandle

type: long

modo.scene.util.collections._sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.scene.util.collections._sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.scene.util.collections._sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.scene.util.collections._sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.scene.util.collections._sys.exc_type

type: type

doc: Inappropriate argument type.

    modo.scene.util.collections._sys.exc_type contents:
  • modo.scene.util.collections._sys.exc_type.__class__
  • modo.scene.util.collections._sys.exc_type.__delattr__
  • modo.scene.util.collections._sys.exc_type.__dict__
  • modo.scene.util.collections._sys.exc_type.__doc__
  • modo.scene.util.collections._sys.exc_type.__format__
  • modo.scene.util.collections._sys.exc_type.__getattribute__
  • modo.scene.util.collections._sys.exc_type.__getitem__
  • modo.scene.util.collections._sys.exc_type.__getslice__
  • modo.scene.util.collections._sys.exc_type.__hash__
  • modo.scene.util.collections._sys.exc_type.__init__
  • modo.scene.util.collections._sys.exc_type.__new__
  • modo.scene.util.collections._sys.exc_type.__reduce__
  • modo.scene.util.collections._sys.exc_type.__reduce_ex__
  • modo.scene.util.collections._sys.exc_type.__repr__
  • modo.scene.util.collections._sys.exc_type.__setattr__
  • modo.scene.util.collections._sys.exc_type.__setstate__
  • modo.scene.util.collections._sys.exc_type.__sizeof__
  • modo.scene.util.collections._sys.exc_type.__str__
  • modo.scene.util.collections._sys.exc_type.__subclasshook__
  • modo.scene.util.collections._sys.exc_type.__unicode__
  • modo.scene.util.collections._sys.exc_type.args
  • modo.scene.util.collections._sys.exc_type.message

modo.scene.util.collections._sys.exc_type.args

type: getset_descriptor

modo.scene.util.collections._sys.exc_type.message

type: getset_descriptor

modo.scene.util.collections._sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.scene.util.collections._sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.scene.util.collections._sys.exec_prefix

type: str

modo.scene.util.collections._sys.executable

type: str

modo.scene.util.collections._sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.scene.util.collections._sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.scene.util.collections._sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.scene.util.collections._sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.scene.util.collections._sys.float_repr_style

type: str

modo.scene.util.collections._sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.scene.util.collections._sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.scene.util.collections._sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.scene.util.collections._sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.scene.util.collections._sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.scene.util.collections._sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.scene.util.collections._sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.scene.util.collections._sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.scene.util.collections._sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.scene.util.collections._sys.hexversion

type: int

modo.scene.util.collections._sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.scene.util.collections._sys.maxint

type: int

modo.scene.util.collections._sys.maxsize

type: long

modo.scene.util.collections._sys.maxunicode

type: int

modo.scene.util.collections._sys.meta_path

type: list
modo.scene.util.collections._sys.modules type: dict

modo.scene.util.collections._sys.modules.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.scene.util.collections._sys.modules.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.scene.util.collections._sys.modules.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.scene.util.collections._sys.modules.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.scene.util.collections._sys.modules.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.scene.util.collections._sys.modules.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.scene.util.collections._sys.modules.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.scene.util.collections._sys.modules.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.scene.util.collections._sys.modules.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.scene.util.collections._sys.modules.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.scene.util.collections._sys.modules.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.scene.util.collections._sys.modules.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.scene.util.collections._sys.modules.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.scene.util.collections._sys.modules.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.scene.util.collections._sys.modules.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.scene.util.collections._sys.modules.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.scene.util.collections._sys.modules.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.scene.util.collections._sys.modules.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.scene.util.collections._sys.path

type: list

modo.scene.util.collections._sys.path_hooks

type: list
modo.scene.util.collections._sys.path_importer_cache type: dict

modo.scene.util.collections._sys.path_importer_cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.scene.util.collections._sys.path_importer_cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.scene.util.collections._sys.path_importer_cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.scene.util.collections._sys.path_importer_cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.scene.util.collections._sys.path_importer_cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.scene.util.collections._sys.path_importer_cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.scene.util.collections._sys.path_importer_cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.scene.util.collections._sys.path_importer_cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.scene.util.collections._sys.path_importer_cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.scene.util.collections._sys.path_importer_cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.scene.util.collections._sys.path_importer_cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.scene.util.collections._sys.path_importer_cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.scene.util.collections._sys.path_importer_cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.scene.util.collections._sys.path_importer_cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.scene.util.collections._sys.path_importer_cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.scene.util.collections._sys.path_importer_cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.scene.util.collections._sys.path_importer_cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.scene.util.collections._sys.path_importer_cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.scene.util.collections._sys.platform

type: str

modo.scene.util.collections._sys.prefix

type: str

modo.scene.util.collections._sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.scene.util.collections._sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.scene.util.collections._sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.scene.util.collections._sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.scene.util.collections._sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.scene.util.collections._sys.stderr

type: SESysStdErr

modo.scene.util.collections._sys.stdin

type: SESysStdIn

modo.scene.util.collections._sys.stdout

type: SESysStdOut

modo.scene.util.collections._sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.util.collections._sys.version

type: str

modo.scene.util.collections._sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.scene.util.collections._sys.warnoptions

type: list

modo.scene.util.collections._sys.winver

type: str

modo.scene.util.collections.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.Counter

type: type

doc: Dict subclass for counting hashable items. Sometimes called a bag or multiset. Elements are stored as dictionary keys and their counts are stored as dictionary values. >>> c = Counter('abcdeabcdabcaba') # count elements from a string >>> c.most_common(3) # three most common elements [('a', 5), ('b', 4), ('c', 3)] >>> sorted(c) # list all unique elements ['a', 'b', 'c', 'd', 'e'] >>> ''.join(sorted(c.elements())) # list elements with repetitions 'aaaaabbbbcccdde' >>> sum(c.values()) # total of all counts 15 >>> c['a'] # count of letter 'a' 5 >>> for elem in 'shazam': # update counts from an iterable ... c[elem] += 1 # by adding 1 to each element's count >>> c['a'] # now there are seven 'a' 7 >>> del c['b'] # remove all 'b' >>> c['b'] # now there are zero 'b' 0 >>> d = Counter('simsalabim') # make another counter >>> c.update(d) # add in the second counter >>> c['a'] # now there are nine 'a' 9 >>> c.clear() # empty the counter >>> c Counter() Note: If a count is set to zero or reduced to zero, it will remain in the counter until the entry is deleted or the counter is cleared: >>> c = Counter('aaabbc') >>> c['b'] -= 2 # reduce the count of 'b' by two >>> c.most_common() # 'b' is still in, but its count is zero [('a', 3), ('c', 1), ('b', 0)]

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.scene.util.collections.Counter.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.scene.util.collections.Counter.copy(self)

type: instancemethod

doc: Return a shallow copy.

file: .\Lib\collections.py

modo.scene.util.collections.Counter.elements(self)

type: instancemethod

doc: Iterator over elements repeating each as many times as its count. >>> c = Counter('ABCABC') >>> sorted(c.elements()) ['A', 'A', 'B', 'B', 'C', 'C'] # Knuth's example for prime factors of 1836: 2**2 * 3**3 * 17**1 >>> prime_factors = Counter({2: 2, 3: 3, 17: 1}) >>> product = 1 >>> for factor in prime_factors.elements(): # loop over factors ... product *= factor # and multiply them >>> product 1836 Note, if an element's count has been set to zero or is a negative number, elements() will ignore it.

file: .\Lib\collections.py

modo.scene.util.collections.Counter.fromkeys(cls,iterable,v)

type: instancemethod

file: .\Lib\collections.py

modo.scene.util.collections.Counter.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.scene.util.collections.Counter.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.scene.util.collections.Counter.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.scene.util.collections.Counter.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.scene.util.collections.Counter.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.scene.util.collections.Counter.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.scene.util.collections.Counter.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.scene.util.collections.Counter.most_common(self,n)

type: instancemethod

doc: List the n most common elements and their counts from the most common to the least. If n is None, then list all element counts. >>> Counter('abcdeabcdabcaba').most_common(3) [('a', 5), ('b', 4), ('c', 3)]

file: .\Lib\collections.py

modo.scene.util.collections.Counter.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.scene.util.collections.Counter.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.scene.util.collections.Counter.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.scene.util.collections.Counter.subtract(self,iterable)

type: instancemethod

doc: Like dict.update() but subtracts counts instead of replacing them. Counts can be reduced below zero. Both the inputs and outputs are allowed to contain zero and negative counts. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.subtract('witch') # subtract elements from another iterable >>> c.subtract(Counter('watch')) # subtract elements from another counter >>> c['h'] # 2 in which, minus 1 in witch, minus 1 in watch 0 >>> c['w'] # 1 in which, minus 1 in witch, minus 1 in watch -1

file: .\Lib\collections.py

modo.scene.util.collections.Counter.update(self,iterable)

type: instancemethod

doc: Like dict.update() but add counts instead of replacing them. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.update('witch') # add elements from another iterable >>> d = Counter('watch') >>> c.update(d) # add elements from another counter >>> c['h'] # four 'h' in which, witch, and watch 4

file: .\Lib\collections.py

modo.scene.util.collections.Counter.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.scene.util.collections.Counter.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.scene.util.collections.Counter.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.scene.util.collections.Counter.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.scene.util.collections.defaultdict

type: type

doc: defaultdict(default_factory) --> dict with default factory The default factory is called without arguments to produce a new value when a key is not present, in __getitem__ only. A defaultdict compares equal to a dict with the same items.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.scene.util.collections.defaultdict.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.scene.util.collections.defaultdict.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D.

modo.scene.util.collections.defaultdict.default_factory

type: member_descriptor

doc: Factory for default value called by __missing__().

modo.scene.util.collections.defaultdict.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.scene.util.collections.defaultdict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.scene.util.collections.defaultdict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.scene.util.collections.defaultdict.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.scene.util.collections.defaultdict.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.scene.util.collections.defaultdict.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.scene.util.collections.defaultdict.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.scene.util.collections.defaultdict.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.scene.util.collections.defaultdict.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.scene.util.collections.defaultdict.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.scene.util.collections.defaultdict.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.scene.util.collections.defaultdict.update()

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.scene.util.collections.defaultdict.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.scene.util.collections.defaultdict.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.scene.util.collections.defaultdict.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.scene.util.collections.defaultdict.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.scene.util.collections.deque

type: type

doc: deque(iterable[, maxlen]) --> deque object Build an ordered collection with optimized access from its endpoints.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.scene.util.collections.deque.append()

type: method_descriptor

doc: Add an element to the right side of the deque.

modo.scene.util.collections.deque.appendleft()

type: method_descriptor

doc: Add an element to the left side of the deque.

modo.scene.util.collections.deque.clear()

type: method_descriptor

doc: Remove all elements from the deque.

modo.scene.util.collections.deque.count()

type: method_descriptor

doc: D.count(value) -> integer -- return number of occurrences of value

modo.scene.util.collections.deque.extend()

type: method_descriptor

doc: Extend the right side of the deque with elements from the iterable

modo.scene.util.collections.deque.extendleft()

type: method_descriptor

doc: Extend the left side of the deque with elements from the iterable

modo.scene.util.collections.deque.maxlen

type: getset_descriptor

doc: maximum size of a deque or None if unbounded

modo.scene.util.collections.deque.pop()

type: method_descriptor

doc: Remove and return the rightmost element.

modo.scene.util.collections.deque.popleft()

type: method_descriptor

doc: Remove and return the leftmost element.

modo.scene.util.collections.deque.remove()

type: method_descriptor

doc: D.remove(value) -- remove first occurrence of value.

modo.scene.util.collections.deque.reverse()

type: method_descriptor

doc: D.reverse() -- reverse *IN PLACE*

modo.scene.util.collections.deque.rotate()

type: method_descriptor

doc: Rotate the deque n steps to the right (default n=1). If n is negative, rotates left.

modo.scene.util.collections.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.namedtuple

type: function

doc: Returns a new subclass of tuple with named fields. >>> Point = namedtuple('Point', 'x y') >>> Point.__doc__ # docstring for the new class 'Point(x, y)' >>> p = Point(11, y=22) # instantiate with positional args or keywords >>> p[0] + p[1] # indexable like a plain tuple 33 >>> x, y = p # unpack like a regular tuple >>> x, y (11, 22) >>> p.x + p.y # fields also accessable by name 33 >>> d = p._asdict() # convert to a dictionary >>> d['x'] 11 >>> Point(**d) # convert from a dictionary Point(x=11, y=22) >>> p._replace(x=100) # _replace() is like str.replace() but targets named fields Point(x=100, y=22)

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict

type: type

doc: Dictionary that remembers insertion order

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.scene.util.collections.OrderedDict._OrderedDict__marker

type: object

doc: The most base type

modo.scene.util.collections.OrderedDict._OrderedDict__update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.scene.util.collections.OrderedDict.clear(self)

type: instancemethod

doc: od.clear() -> None. Remove all items from od.

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.copy(self)

type: instancemethod

doc: od.copy() -> a shallow copy of od

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.fromkeys(cls,iterable,value)

type: instancemethod

doc: OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S. If not specified, the value defaults to None.

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.scene.util.collections.OrderedDict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.scene.util.collections.OrderedDict.items(self)

type: instancemethod

doc: od.items() -> list of (key, value) pairs in od

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.iteritems(self)

type: instancemethod

doc: od.iteritems -> an iterator over the (key, value) pairs in od

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.iterkeys(self)

type: instancemethod

doc: od.iterkeys() -> an iterator over the keys in od

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.itervalues(self)

type: instancemethod

doc: od.itervalues -> an iterator over the values in od

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.keys(self)

type: instancemethod

doc: od.keys() -> list of keys in od

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.pop(self,key,default)

type: instancemethod

doc: od.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.popitem(self,last)

type: instancemethod

doc: od.popitem() -> (k, v), return and remove a (key, value) pair. Pairs are returned in LIFO order if last is true or FIFO order if false.

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.setdefault(self,key,default)

type: instancemethod

doc: od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.scene.util.collections.OrderedDict.values(self)

type: instancemethod

doc: od.values() -> list of values in od

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.viewitems(self)

type: instancemethod

doc: od.viewitems() -> a set-like object providing a view on od's items

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.viewkeys(self)

type: instancemethod

doc: od.viewkeys() -> a set-like object providing a view on od's keys

file: .\Lib\collections.py

modo.scene.util.collections.OrderedDict.viewvalues(self)

type: instancemethod

doc: od.viewvalues() -> an object providing a view on od's values

file: .\Lib\collections.py

modo.scene.util.collections.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.collections.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.ensureModoItem

type: function

doc: Decorator - ensures that the argument passed as the first parameter to a function is an instance of the modo :class:`Item` class. Should only only be used to decorate methods where the first argument is meant to be an item and ensures that if for any reason an item of either type lx.object.Item or lxu.object.Item gets passed to the method it will get wrapped as an modo.item.Item object before being used.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.util.floatEquals

type: function

doc: Test if two floats are equal :returns bool:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.util.functools

type: module

doc: functools.py - Tools for working with functions and callable objects

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

modo.scene.util.functools.cmp_to_key

type: function

doc: Convert a cmp= function into a key= function

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.scene.util.functools.partial

type: type

doc: partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

    modo.scene.util.functools.partial contents:
  • modo.scene.util.functools.partial.__call__
  • modo.scene.util.functools.partial.__class__
  • modo.scene.util.functools.partial.__delattr__
  • modo.scene.util.functools.partial.__dict__
  • modo.scene.util.functools.partial.__doc__
  • modo.scene.util.functools.partial.__format__
  • modo.scene.util.functools.partial.__getattribute__
  • modo.scene.util.functools.partial.__hash__
  • modo.scene.util.functools.partial.__init__
  • modo.scene.util.functools.partial.__new__
  • modo.scene.util.functools.partial.__reduce__
  • modo.scene.util.functools.partial.__reduce_ex__
  • modo.scene.util.functools.partial.__repr__
  • modo.scene.util.functools.partial.__setattr__
  • modo.scene.util.functools.partial.__setstate__
  • modo.scene.util.functools.partial.__sizeof__
  • modo.scene.util.functools.partial.__str__
  • modo.scene.util.functools.partial.__subclasshook__
  • modo.scene.util.functools.partial.args
  • modo.scene.util.functools.partial.func
  • modo.scene.util.functools.partial.keywords

modo.scene.util.functools.partial.args

type: member_descriptor

doc: tuple of arguments to future partial calls

modo.scene.util.functools.partial.func

type: member_descriptor

doc: function object to use in future partial calls

modo.scene.util.functools.partial.keywords

type: member_descriptor

doc: dictionary of keyword arguments to future partial calls

modo.scene.util.functools.reduce()

type: builtin_function_or_method

doc: reduce(function, sequence[, initial]) -> value Apply a function of two arguments cumulatively to the items of a sequence, from left to right, so as to reduce the sequence to a single value. For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates ((((1+2)+3)+4)+5). If initial is present, it is placed before the items of the sequence in the calculation, and serves as a default when the sequence is empty.

modo.scene.util.functools.total_ordering

type: function

doc: Class decorator that fills in missing ordering methods

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.scene.util.functools.update_wrapper

type: function

doc: Update a wrapper function to look like the wrapped function wrapper is the function to be updated wrapped is the original function assigned is a tuple naming the attributes assigned directly from the wrapped function to the wrapper function (defaults to functools.WRAPPER_ASSIGNMENTS) updated is a tuple naming the attributes of the wrapper that are updated with the corresponding attribute from the wrapped function (defaults to functools.WRAPPER_UPDATES)

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.scene.util.functools.WRAPPER_ASSIGNMENTS

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.util.functools.WRAPPER_UPDATES

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.scene.util.functools.wraps

type: function

doc: Decorator factory to apply update_wrapper() to a wrapper function Returns a decorator that invokes update_wrapper() with the decorated function as the wrapper argument and the arguments to wraps() as the remaining arguments. Default arguments are as for update_wrapper(). This is a convenience function to simplify applying partial() to update_wrapper().

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.scene.util.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip

type: type

doc: Action Clip and Render pass item. :param item: either an item of type 'actionclip' or an item name/ID to lookup. :type item: an instance of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip._item

type: property

modo.scene.util.item.ActionClip._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.active

type: property

doc: Set or get the active state of the render pass. :getter: Returns the active state of the render pass. :rtype: bool :setter: Sets the active state of the renter pass :param state: active state. :type state: bool

modo.scene.util.item.ActionClip.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.ActionClip.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.ActionClip.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.ActionClip.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.ActionClip.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.enabled

type: property

doc: Get or set the enabled state of the render pass. :getter: Returns the enabled state. :rtype: bool :setter: Sets the enabled state of the render pass :param state: enabled state. :type state: bool

modo.scene.util.item.ActionClip.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.getValue(self,chan,time)

type: instancemethod

doc: Read a value set on a channel for this render pass. :param chan: the channel to read the value from. :type chan: modo.channel.Channel object :param time: the time (in seconds) to read the value for, defaults to 0.0. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.ActionClip.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.ActionClip.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.ActionClip.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.ActionClip.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.ActionClip.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.ActionClip.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.name

type: property

doc: Name of the render pass. :getter: Returns the name of the render pass :rtype: basestring :setter: Assigns a new name to the render pass :param name: new name for the render pass. :type name: basestring

modo.scene.util.item.ActionClip.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.ActionClip.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.ActionClip.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.ActionClip.passGroup

type: property

doc: The render pass group that the render pass belongs to. :getter: Returns the render pass group :rtype: modo.item.RenderPassGroup :setter: Sets the render pass group :param group: render pass group to parent to. :type group: modo.item.RenderPassGroup

modo.scene.util.item.ActionClip.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.scene

type: property

modo.scene.util.item.ActionClip.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.ActionClip.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.setValue(self,chan,value,time,key)

type: instancemethod

doc: Set a value on a channel for this render pass. :param chan: the channel to set the value on. :type chan: modo.channel.Channel object :param value: the value to set for the channel. :type value: any :param time: the time (in seconds) to set the value for, defaults to 0.0. :type time: float :param key: whether to set a key for the value or not, defaults to False. :param key: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ActionClip.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.ActionClip.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Actor

type: type

doc: Wrapper class for actor groups.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor._Actor__addClip(self,name,pose)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor._item

type: property

modo.scene.util.item.Actor._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.actions

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.scene.util.item.Actor.addAction(self,name)

type: instancemethod

doc: Adds an action to this actor Note: please avoid naming actions 'setup', 'edit' or 'scene' :returns ActionClip: ActionClip :param basestring name: Optional name for the action

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.addPose(self,name,activate)

type: instancemethod

doc: Adds a pose to this actor :returns ActionClip: ActionClip :param basestring name: Optional name for the pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.Actor.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.Actor.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.Actor.currentAction

type: property

doc: :getter: Returns the currently active action if any. None if no action is active :rtype: ActionClip

modo.scene.util.item.Actor.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.Actor.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.scene.util.item.Actor.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.scene.util.item.Actor.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.Actor.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.Actor.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.Actor.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.Actor.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.scene.util.item.Actor.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.Actor.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.Actor.items

type: property

doc: :getter: Returns a list of LocatorSuperType items that are connected to this action. :rtype: list

modo.scene.util.item.Actor.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.Actor.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.Actor.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.Actor.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.Actor.pose(self,poseName)

type: instancemethod

doc: Return a pose by name :param basestring poseName: Name of the pose to look up :returns: Pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.poses

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.scene.util.item.Actor.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.scene

type: property

modo.scene.util.item.Actor.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.Actor.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Actor.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Actor.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.scene.util.item.AreaLight

type: type

doc: Area light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Area Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. :param light: Optional area light item object (type lx.symbol.sITYPE_AREALIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid area light item selected. :raises TypeError: if the item passed as an argument isn't either an area light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight._item

type: property

modo.scene.util.item.AreaLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.AreaLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.AreaLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.AreaLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.AreaLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.AreaLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.AreaLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.AreaLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.AreaLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.AreaLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.AreaLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.util.item.AreaLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.AreaLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.AreaLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.AreaLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.AreaLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.AreaLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.AreaLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.AreaLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.AreaLight.scene

type: property

modo.scene.util.item.AreaLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.AreaLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.AreaLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.AreaLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.AreaLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.scene.util.item.Camera

type: type

doc: Camera item class. Takes an optional 'camera' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'camera' or an item name or ID to look up. If no camera item is supplied as an argument an attempt will be made to wrap the most recently selected camera. :param camera: Optional camera item object (type lx.symbol.sITYPE_CAMERA) or string (item name or ID) to look up. :type camera: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid camera item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'camera' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the camera argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera._item

type: property

modo.scene.util.item.Camera._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.Camera.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.Camera.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.Camera.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.Camera.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.Camera.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.Camera.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.Camera.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.Camera.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.Camera.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.Camera.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.Camera.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.Camera.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.Camera.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.Camera.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Camera.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Camera.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Camera.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Camera.scene

type: property

modo.scene.util.item.Camera.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.Camera.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Camera.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Camera.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.Camera.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Channel

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Add a link between this channel and another. :param to_channel: The channel to link to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Channel.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Delete a link from the channel graph. :param to_channel: The channel the link is to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Channel.disconnectInput(self,other)

type: instancemethod

doc: Removes an input connection from another channel if it exists. :param Channel other: Other channel to disconnect from. If it is None, all input connections are removed.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Channel.envelope

type: property

doc: Returns the channel's animation envelope. :getter: Returns the channel's animation envelope. :rtype: modo.channel.Envelope :raises LookupError: if the channel isn't animated.

modo.scene.util.item.Channel.evalType

type: property

doc: Returns the evaluation type of a channel, which is the type of slot allocated in the eval state vector. This will return the "gradstack" exo-type for gradient channels. :getter: Returns the evaluation type of the channel :rtype: basestring

modo.scene.util.item.Channel.forward(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index forward of this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index forward of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Channel.fwdCount

type: property

doc: Returns the number of linked channels forward of this channel in this channel graph. :getter: Returns the number of linked channels forward of this channel in this channel graph. :rtype: int

modo.scene.util.item.Channel.fwdLinked

type: property

doc: Returns a list of the linked channels forward of this channel in the channel graph. :getter: Returns the forward channels in this item's channel graph. :rtype: list

modo.scene.util.item.Channel.get(self,time,action)

type: instancemethod

doc: Returns a channel's value for an action at a specific time. Defaults to reading the channel's evaluated value at the current time. :param time: Optional time in seconds to read the value at. :type time: float :param action: The action to read the value from. Defaults to None (evaluation). :type action: basestring :returns: the channel's value. :rtype: depends on the type of the channel being read.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Channel.graph

type: property

doc: The channel's channel graph. :getter: Returns the channel's channel graph. :rtype: lxu.object.ChannelGraph

modo.scene.util.item.Channel.index

type: property

doc: The channel's index. :getter: Returns the channel's index. :rtype: int

modo.scene.util.item.Channel.isAnimated

type: property

doc: Returns whether the channel is animated. :getter: Returns whether the channel is animated or not. :rtype: bool

modo.scene.util.item.Channel.item

type: property

doc: :getter: Returns the item that is associated with this channel :rtype: Item

modo.scene.util.item.Channel.name

type: property

doc: The channel's name. :getter: Returns the channel's name. :rtype: basestring

modo.scene.util.item.Channel.revCount

type: property

doc: Returns the number of linked channels that occur before this channel in the channel graph. :getter: Returns the number of linked channels that occur before this channel in the channel graph. :rtype: int

modo.scene.util.item.Channel.reverse(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index before this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index before of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Channel.revLinked

type: property

doc: Returns a list of the linked channels that appear before this channel in the channel graph. :getter: Returns the linked channels that appear before this channel in the channel graph. :rtype: list

modo.scene.util.item.Channel.set(self,value,time,key,action)

type: instancemethod

doc: Sets a channel's value for an action at a specific time. Defaults to setting the channel's value for the "edit" action and at the current time. :param value: The value to set for the channel. :type value: depends on the type of the channel :param time: optional time in seconds to set the value for. :type time: float :param key: Specifies whether to set a key for the channel. :type key: bool :param action: The action to set the value on. :type action: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Set a link's position (from index, to index) in the channel graph. :param from_index: The index in the channel graph for the current (from) channel. :type from_index: int :param to_channel: The to channel. :type to_channel: modo.channel.Channel :param to_index: the index in the channel graph for the 'to' channel. :type to_index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Channel.storageType

type: property

doc: Returns the storage type of the channel, which can be valid exo-type name for numeric and stored custom types or None if no storage type is found. :getter: Returns the channel storage type :rtype: basestring

modo.scene.util.item.Channel.type

type: property

doc: Returns the channel type. The numeric and gradient types can be keyframed. The return type is an int which translates to the following types: | 0: none | 1: integer | 2: float | 3: gradient | 4: storage | 5: eval :getter: Returns the channel type. :rtype: int

modo.scene.util.item.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.scene.util.item.ChannelRead contents:
  • modo.scene.util.item.ChannelRead.__class__
  • modo.scene.util.item.ChannelRead.__delattr__
  • modo.scene.util.item.ChannelRead.__dict__
  • modo.scene.util.item.ChannelRead.__doc__
  • modo.scene.util.item.ChannelRead.__format__
  • modo.scene.util.item.ChannelRead.__getattr__
  • modo.scene.util.item.ChannelRead.__getattribute__
  • modo.scene.util.item.ChannelRead.__hash__
  • modo.scene.util.item.ChannelRead.__init__
  • modo.scene.util.item.ChannelRead.__module__
  • modo.scene.util.item.ChannelRead.__new__
  • modo.scene.util.item.ChannelRead.__reduce__
  • modo.scene.util.item.ChannelRead.__reduce_ex__
  • modo.scene.util.item.ChannelRead.__repr__
  • modo.scene.util.item.ChannelRead.__setattr__
  • modo.scene.util.item.ChannelRead.__sizeof__
  • modo.scene.util.item.ChannelRead.__str__
  • modo.scene.util.item.ChannelRead.__subclasshook__
  • modo.scene.util.item.ChannelRead.__weakref__
  • modo.scene.util.item.ChannelRead.set

modo.scene.util.item.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.ChannelTriple

type: type

doc: Wrapper to allow setting and reading all three channels on a vector 'channel' at once :param basestring channelName: The channel name. eg 'diffCol' :param modo.item.Item item: The item the channel belongs to. :raises: LookUpError if no respective channel of the given name was found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.scene.util.item.ChannelTriple contents:
  • modo.scene.util.item.ChannelTriple.__class__
  • modo.scene.util.item.ChannelTriple.__delattr__
  • modo.scene.util.item.ChannelTriple.__dict__
  • modo.scene.util.item.ChannelTriple.__doc__
  • modo.scene.util.item.ChannelTriple.__format__
  • modo.scene.util.item.ChannelTriple.__getattribute__
  • modo.scene.util.item.ChannelTriple.__hash__
  • modo.scene.util.item.ChannelTriple.__init__
  • modo.scene.util.item.ChannelTriple.__module__
  • modo.scene.util.item.ChannelTriple.__new__
  • modo.scene.util.item.ChannelTriple.__reduce__
  • modo.scene.util.item.ChannelTriple.__reduce_ex__
  • modo.scene.util.item.ChannelTriple.__repr__
  • modo.scene.util.item.ChannelTriple.__setattr__
  • modo.scene.util.item.ChannelTriple.__sizeof__
  • modo.scene.util.item.ChannelTriple.__str__
  • modo.scene.util.item.ChannelTriple.__subclasshook__
  • modo.scene.util.item.ChannelTriple.__weakref__
  • modo.scene.util.item.ChannelTriple.get
  • modo.scene.util.item.ChannelTriple.set

modo.scene.util.item.ChannelTriple.get(self)

type: instancemethod

doc: Same arguments as Channel.get()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.ChannelTriple.set(self,values,time,action)

type: instancemethod

doc: Sets three values for the three channels at once :param float time: Time in seconds for the value to be set at (optional) :param basestring action: Action to set the value for (optional)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.scene.util.item.ChannelWrite contents:
  • modo.scene.util.item.ChannelWrite.__class__
  • modo.scene.util.item.ChannelWrite.__delattr__
  • modo.scene.util.item.ChannelWrite.__dict__
  • modo.scene.util.item.ChannelWrite.__doc__
  • modo.scene.util.item.ChannelWrite.__format__
  • modo.scene.util.item.ChannelWrite.__getattr__
  • modo.scene.util.item.ChannelWrite.__getattribute__
  • modo.scene.util.item.ChannelWrite.__hash__
  • modo.scene.util.item.ChannelWrite.__init__
  • modo.scene.util.item.ChannelWrite.__module__
  • modo.scene.util.item.ChannelWrite.__new__
  • modo.scene.util.item.ChannelWrite.__reduce__
  • modo.scene.util.item.ChannelWrite.__reduce_ex__
  • modo.scene.util.item.ChannelWrite.__repr__
  • modo.scene.util.item.ChannelWrite.__setattr__
  • modo.scene.util.item.ChannelWrite.__sizeof__
  • modo.scene.util.item.ChannelWrite.__str__
  • modo.scene.util.item.ChannelWrite.__subclasshook__
  • modo.scene.util.item.ChannelWrite.__weakref__
  • modo.scene.util.item.ChannelWrite.set

modo.scene.util.item.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.CylinderLight

type: type

doc: Cylinder light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Cylinder Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Cylinder Light item. :param light: Optional Cylinder light item object (type lx.symbol.sITYPE_CYLINDERLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid cylinder light item selected. :raises TypeError: if the item passed as an argument isn't either a cylinder light or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight._item

type: property

modo.scene.util.item.CylinderLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.CylinderLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.CylinderLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.CylinderLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.CylinderLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.CylinderLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.CylinderLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.CylinderLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.CylinderLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.CylinderLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.CylinderLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.util.item.CylinderLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.CylinderLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.CylinderLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.CylinderLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.CylinderLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.CylinderLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.CylinderLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.CylinderLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.CylinderLight.scene

type: property

modo.scene.util.item.CylinderLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.CylinderLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.CylinderLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.CylinderLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.CylinderLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Deformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer._item

type: property

modo.scene.util.item.Deformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.Deformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.Deformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.Deformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.Deformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.Deformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.Deformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.Deformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.Deformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.Deformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.Deformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.scene.util.item.Deformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.Deformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.scene.util.item.Deformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.Deformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.Deformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.Deformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.scene

type: property

modo.scene.util.item.Deformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.Deformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Deformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Deformer.svc

type: Deformer

modo.scene.util.item.Deformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.DeformerGroup

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup._item

type: property

modo.scene.util.item.DeformerGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.DeformerGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.DeformerGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.DeformerGroup.connectInput(self,other)

type: instancemethod

doc: Connects an influence deformer into this deformGroup :param other:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.createJointLocator(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.DeformerGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.DeformerGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.DeformerGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.DeformerGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.DeformerGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.DeformerGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.DeformerGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.mesh(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.DeformerGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.DeformerGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.DeformerGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.DeformerGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.scene

type: property

modo.scene.util.item.DeformerGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.DeformerGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DeformerGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.DeformerGroup.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.DirectionalLight

type: type

doc: Directional light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Directional Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Directional Light item. :param light: Optional Directional light item object (type lx.symbol.sITYPE_SUNLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid directional light item selected. :raises TypeError: if the item passed as an argument isn't either a Directional light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight._item

type: property

modo.scene.util.item.DirectionalLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.DirectionalLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.DirectionalLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.DirectionalLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.DirectionalLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.DirectionalLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.DirectionalLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.DirectionalLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.DirectionalLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.DirectionalLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.DirectionalLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.util.item.DirectionalLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.DirectionalLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.DirectionalLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.DirectionalLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.DirectionalLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.DirectionalLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.DirectionalLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.DirectionalLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.DirectionalLight.scene

type: property

modo.scene.util.item.DirectionalLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.DirectionalLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DirectionalLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.DirectionalLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.DirectionalLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.DomeLight

type: type

doc: Dome light item class Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Dome Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Dome Light item. :param light: Optional Dome light item object (type lx.symbol.sITYPE_DOMELIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Dome light item selected. :raises TypeError: if the item passed as an argument isn't either a Dome light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight._item

type: property

modo.scene.util.item.DomeLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.DomeLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.DomeLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.DomeLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.DomeLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.DomeLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.DomeLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.DomeLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.DomeLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.DomeLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.DomeLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.util.item.DomeLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.DomeLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.DomeLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.DomeLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.DomeLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.DomeLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.DomeLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.DomeLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.DomeLight.scene

type: property

modo.scene.util.item.DomeLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.DomeLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.DomeLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.DomeLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.DomeLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Envelope

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Envelope.behavior

type: property

doc: gets/sets the behavior of times for both before the first keyframe and after the last keyframe in the envelope. :setter: Sets the envelope behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope behavior :rtype: int

modo.scene.util.item.Envelope.clear(self)

type: instancemethod

doc: Clears (removes all keys from) the envelope.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Envelope.interpolation

type: property

doc: Returns the interpolation setting for the envelope. Can be one of: | lx.symbol.iENVv_INTERP_CURVE | lx.symbol.iENVv_INTERP_LINEAR | lx.symbol.iENVv_INTERP_STEPPED :getter: Returns the interpolation setting for the envelope. :rtype: int

modo.scene.util.item.Envelope.isInt

type: property

doc: Returns whether the envelope is integer-valued type, if not it's a float type. :Getter: Returns True if the envelope is integer-valued type, False otherwise. :rtype: bool

modo.scene.util.item.Envelope.keyframes

type: property

doc: Returns a :class:`Keyframes` object that provides access to the keyframes set for the envelope and methods to manipulate them. :getter: Returns a :class:`Keyframes` object containing the keys for this envelope. :rtype: modo.channel.Keyframes

modo.scene.util.item.Envelope.postBehaviour

type: property

doc: gets/sets the behavior of times after the last keyframe in the envelope. :setter: Sets the envelope post behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope post behavior :rtype: int

modo.scene.util.item.Envelope.preBehaviour

type: property

doc: gets/sets the behavior of times before the first keyframe in the envelope. - **RESET** A default value, or may be just zero. - **CONSTANT** The value of the first or last keyframe. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **REPEAT** The values in the keyframe range repeating continuously. - **OSCILLATE** Like repeat, but the values run forwards and backward alternately. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **OFFSETREPEAT** Like repeat, but the values are offset in each cycle by the difference between the first and last keyframes. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **LINEAR** Linear interpolation from the slope at the nearest keyframe. - **NONE** Indicates that the envelope does not exist before or after the explicit keyframe range. This can be used by motion evaluation code to decide whether to use the envelope for a channel or to look up the parent envelope or default value. - **CONSTANT_KEEP_SLOPE** As for constant except that the slopes of the first or last keys are not changed. - **OSCILLATE_KEEP_SLOPE** As for oscillate except that the slopes of the first or last keys are not changed. - **OFFSETREPEAT_KEEP_SLOPE** As for offset repeat except that the slopes of the first or last keys are not changed. :setter: Sets the behavior :param behavior: the behaviour to set for the envelope. Can be one of: | lx.symbol.iENV_RESET | lx.symbol.iENV_CONSTANT | lx.symbol.iENV_REPEAT | lx.symbol.iENV_OSCILLATE | lx.symbol.iENV_OFFSETREPEAT | lx.symbol.iENV_LINEAR | lx.symbol.iENV_NONE | lx.symbol.iENV_CONSTANT_KEEP_SLOPE | lx.symbol.iENV_OSCILLATE_KEEP_SLOPE | lx.symbol.iENV_OFFSETREPEAT_KEEP_SLOPE :type behavior: int :getter: Returns envelope behavior :rtype: int

modo.scene.util.item.Envelope.value(self,time)

type: instancemethod

doc: Returns the value of the envelope evaluated at the specified time. If no time is explicitly provided the value of the envelope at the current time is returned :param time: time to evaluate envelope at. :type time: float :returns: value of the envelope :rtype: float for float type envelopes, int for integer-valued type envelopes

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.scene.util.item.GeneralInfluenceDeformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer._item

type: property

modo.scene.util.item.GeneralInfluenceDeformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.GeneralInfluenceDeformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.GeneralInfluenceDeformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.GeneralInfluenceDeformer.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.GeneralInfluenceDeformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.GeneralInfluenceDeformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.GeneralInfluenceDeformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.GeneralInfluenceDeformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.GeneralInfluenceDeformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.GeneralInfluenceDeformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.GeneralInfluenceDeformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.mapName

type: property

doc: :getter: Returns the UI version of the map name as string

modo.scene.util.item.GeneralInfluenceDeformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.scene.util.item.GeneralInfluenceDeformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.GeneralInfluenceDeformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.scene.util.item.GeneralInfluenceDeformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.GeneralInfluenceDeformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.GeneralInfluenceDeformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.GeneralInfluenceDeformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.scene

type: property

modo.scene.util.item.GeneralInfluenceDeformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.GeneralInfluenceDeformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GeneralInfluenceDeformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.GeneralInfluenceDeformer.svc

type: Deformer

modo.scene.util.item.GeneralInfluenceDeformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Group

type: type

doc: A group item. Takes an optional 'groupItem' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group' or an item name or ID to look up. If no groupItem is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. 'gtype' can be any one of the built in group types by passing one of the built in type strings ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader'), an empty string for a general group or any other string to create a custom group type. :param groupItem: an optional group item (type lx.symbol.sITYPE_GROUP) or an item name/ID to look up. :type groupItem: an instance of lx.object.Item, lxu.object.item or modo.item.Item :param gtype: the group type. :type gtype: basestring :raises TypeError: if an item is supplied as the groupItem argument but is not of type lx.symbol.sITYPE_GROUP. :raises ValueError: if no groupItem argument is supplied and no valid group item is selected in the scene. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found. Note that the children() method derived from the Item object will only list child groups. To iterate the contained items, use the method items.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group._item

type: property

modo.scene.util.item.Group._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.Group.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.Group.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.Group.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.Group.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.scene.util.item.Group.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.scene.util.item.Group.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.Group.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.Group.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.Group.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.Group.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.scene.util.item.Group.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.Group.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.Group.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.scene.util.item.Group.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.Group.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.Group.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.Group.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.Group.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.scene

type: property

modo.scene.util.item.Group.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.Group.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Group.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Group.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.scene.util.item.GroupLocator

type: type

doc: Group locator item class. Takes an optional 'grploc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group locator' or an item name or ID to look up. If no grploc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param grploc: Optional group locator item object (type lx.symbol.sITYPE_GROUPLOCATOR) or string (item name or ID) to look up. :type grploc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid group locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'group locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the grploc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator._item

type: property

modo.scene.util.item.GroupLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.GroupLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.GroupLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.GroupLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.GroupLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.GroupLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.GroupLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.GroupLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.GroupLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.GroupLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.GroupLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.GroupLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.GroupLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.GroupLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.GroupLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.GroupLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.GroupLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.GroupLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.GroupLocator.scene

type: property

modo.scene.util.item.GroupLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.GroupLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.GroupLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.GroupLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.GroupLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Item

type: type

doc: Base item class Takes an optional lx.object.Item object as an argument. If none is provided (the default) then the most recently selected item is used. :param item: Optional item object to wrap. :type item: an instance of lx.object.Item or lxu.object.item :raises ValueError: if no item is passed as an argument and no valid items are currently selected. :raises LookupError: if a string (item name or ID) is passed as the item argument and no item with that name or ID cane be found in the scene. :raises TypeError: if the object passed as the 'item' argument isn't an instance of lx.object.Item.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item._item

type: property

modo.scene.util.item.Item._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.Item.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.Item.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.Item.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.Item.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.Item.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.Item.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.Item.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.Item.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.Item.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.Item.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.Item.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.Item.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.Item.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.Item.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.scene

type: property

modo.scene.util.item.Item.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.Item.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Item.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Item.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.ItemGraph

type: type

doc: Utility container class for quick access to ItemGraph compatible graphs :param item: Item to look up graph for :param ls.symbol.sGRAPH_* graphType: Graph to look up. Common ones are 'parent', 'deformers', 'groups', 'chanMods' :param bool reverse: Indices traverse the graph forwards if false or reverse if true

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ItemGraph._ItemGraph__toType

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ItemGraph.connectedItems

type: property

doc: :getter: Returns a dictionary that lists the input- and output items at once. :rtype: dictionary

modo.scene.util.item.ItemGraph.connectInput(self,other)

type: instancemethod

doc: Connects the given item as input. This function is called by the >> operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ItemGraph.disconnectInput(self,other)

type: instancemethod

doc: Removes the given item from the input connections if any. This function is called by the << operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ItemGraph.forward(self,index)

type: instancemethod

doc: :returns list: Items of the forward connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ItemGraph.item

type: property

doc: :getter: Returns the Item that this ItemGraph instance is bound to. :return type: Item

modo.scene.util.item.ItemGraph.reverse(self,index)

type: instancemethod

doc: :returns list: Items of the reverse connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ItemGraph.setReverse(self,reverse)

type: instancemethod

doc: Sets the direction that is used for lookup when using the angular brackets [] :param bool reverse: If True the graph is looked up forwards, if False, backwards.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.ItemGraph.type

type: property

doc: :getter: Returns the name of the graph type that this instance represents. :return type: basestring

modo.scene.util.item.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.scene.util.item.Joint

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint._item

type: property

modo.scene.util.item.Joint._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.Joint.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.Joint.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.Joint.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.Joint.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.Joint.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.Joint.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.Joint.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.Joint.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.Joint.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.Joint.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.Joint.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.Joint.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.Joint.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.Joint.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Joint.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Joint.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Joint.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Joint.scene

type: property

modo.scene.util.item.Joint.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.Joint.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Joint.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Joint.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.Joint.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Keyframes

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Keyframes._indexFromTime(self,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Keyframes.add(self,val,time)

type: instancemethod

doc: Adds a new keyframe at the specified time. If no time value is passed as an argument a keyframe is set at the current time. :param time: optional time (in seconds) to add a keyframe at. :type time: float :param val: the value to set for the keyframe :type val: int or float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Keyframes.delete(self)

type: instancemethod

doc: Deletes the current key

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Keyframes.first(self)

type: instancemethod

doc: Go to the first keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Keyframes.getSlopeType(self,side)

type: instancemethod

doc: Returns the slope type for either side of a keyframe. :returns: a tuple of the slope type set for the side of the keyframe specified and whether the slope is weighted or not. :rtype: (int, int)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Keyframes.last(self)

type: instancemethod

doc: Go to the last keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Keyframes.next(self)

type: instancemethod

doc: Go to the next keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Keyframes.numKeys

type: property

doc: :getter: Returns the number of keyframes found :rtype: int

modo.scene.util.item.Keyframes.prev(self)

type: instancemethod

doc: Go to the previous keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Keyframes.setIndex(self,index)

type: instancemethod

doc: Go to the keyframe by index

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Keyframes.setSlopeType(self,stype,side)

type: instancemethod

doc: Sets the slope type for either side of a keyframe - **SLOPE_DIRECT** the slope of the tangent is set based on the value stored in the key. - **SLOPE_AUTO** the slope of the tangent is calculated automatically with regard to surrounding keys. This is similar to the slope adjustments made by TCB curves. - **SLOPE_LINEAR_IN** the slope of the tangent is calculated to align with the previous key's value. - **SLOPE_LINEAR_OUT** the slope of the tangent is calculated to align with the next key's value. - **SLOPE_FLAT** The slope of the tangent is set to zero. - **SLOPE_AUTOFLAT** the same as auto but if a neighboring key has the same value as the key the slope is set to zero. - **SLOPE_STEPPED** Maintains the value of the previous key between pairs of keys. :param stype: set the slope type for the current keyframe. Can be one of: | lx.symbol.iSLOPE_AUTO | lx.symbol.iSLOPE_AUTOFLAT | lx.symbol.iSLOPE_DIRECT | lx.symbol.iSLOPE_FLAT | lx.symbol.iSLOPE_LINEAR_IN | lx.symbol.iSLOPE_LINEAR_OUT | lx.symbol.iSLOPE_STEPPED :type stype: int :param side: the side of the key (in or out) the slope type is being set for :type side: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.scene.util.item.Keyframes.time

type: property

doc: Returns & sets the time for the current keyframe. :setter: Sets the time :param time: the time to move the key to. :type time: float :getter: Returns the time of the current keyframe :rtype: float

modo.scene.util.item.Keyframes.value

type: property

doc: Convenience property to get & set value of the current keyframe for the 90% case of an unbroken key. :setter: Sets a value :param val: the value to set for the key. :type val: int or float :getter: Returns the value of an (unbroken) key. :rtype: int or float

modo.scene.util.item.Light

type: type

doc: Base Light item class. Each light item encapsulates both an lx.object.Item object (via inheritance from the Item class) of a specific modo light type and a corresponding lx.object.Item of type 'lightMaterial' as a :class:`LightMaterial` object via the light's material property. example:: # to set the diffuse color on the currently selected spotlight spotlight = modo.SpotLight() spotlight.material.ch_diffCol.set((0.7, 0.1, 0.5)) .. note:: Although "Light" isn't technically a base class since, like all other classes in modo.item, it inherits from "Item", it does encapsulate modo's 'Light" supertype and can be treated as a kind of 'pseudo' base class for all modo's light types. As such it should not be instantiated directly, create one of the specific light types instead. | :param light: Optional light item object to wrap. Must be a specific type of light, not the light supertype. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid light item selected. :raises TypeError: if the item passed as an argument isn't an instance of a specific subclass of Light.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light._item

type: property

modo.scene.util.item.Light._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.Light.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.Light.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.Light.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.Light.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.Light.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.Light.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.Light.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.Light.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.Light.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.Light.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.util.item.Light.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.Light.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.Light.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.Light.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.Light.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Light.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Light.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Light.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Light.scene

type: property

modo.scene.util.item.Light.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.Light.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Light.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Light.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.Light.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.LightMaterial

type: type

doc: Wraps a light material texture layer item. :param material: the light material item to be wrapped. :type material: lx.object.Item of type lx.symbol.sITYPE_LIGHTMATERIAL

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial._item

type: property

modo.scene.util.item.LightMaterial._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.LightMaterial.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.LightMaterial.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.LightMaterial.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.LightMaterial.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.LightMaterial.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.LightMaterial.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.LightMaterial.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.LightMaterial.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.LightMaterial.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.LightMaterial.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.light

type: property

doc: :getter: The light item that the material belongs to. :param light_item: the light item to parent the material layer to. :type light_item: an instance of one of the modo.Light types or either lx.object.Item or lxu.object.Item of a specific light item type :returns: the parent light item. :rtype: one of the modo light types.

modo.scene.util.item.LightMaterial.lightCol

type: property

doc: A wrapper property for the light material item's three diffuse color channels. Returns an :class:`modo.channel.Channel` object :getter: Returns a channelTriple object. :rtype: modo.channel.channelTriple

modo.scene.util.item.LightMaterial.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.LightMaterial.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.LightMaterial.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.LightMaterial.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.LightMaterial.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.scatteringCol

type: property

doc: :getter: A wrapper property for the light material item's three scattering color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.scene.util.item.LightMaterial.scene

type: property

modo.scene.util.item.LightMaterial.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.LightMaterial.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LightMaterial.shadCol

type: property

doc: :getter: A wrapper property for the light material item's three shadow color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.scene.util.item.LightMaterial.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.LightMaterial.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Locator

type: type

doc: Locator item class. Takes an optional 'locator' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'locator' or an item name or ID to look up. If no locator item is supplied as an argument an attempt will be made to wrap the most recently selected locator item. :param locator: Optional locator item object (type lx.symbol.sITYPE_LOCATOR) or string (item name or ID) to look up. :type locator: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the locator argument but no item with that name/ID can be found. Hint: Items of other locator derived types should be casted as LocatorSuperType, casting to this class will fail.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator._item

type: property

modo.scene.util.item.Locator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.Locator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.Locator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.Locator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.Locator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.Locator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.Locator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.Locator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.Locator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.Locator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.Locator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.Locator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.Locator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.Locator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.Locator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Locator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Locator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Locator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Locator.scene

type: property

modo.scene.util.item.Locator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.Locator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Locator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Locator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.Locator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.LocatorSuperType

type: type

doc: The LocatorSuperType reflects all items that can be seen and transformed in the 3d view. Locators have transform items that hold the respective transform channels, such as position and rotation.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType._item

type: property

modo.scene.util.item.LocatorSuperType._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.LocatorSuperType.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.LocatorSuperType.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.LocatorSuperType.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.LocatorSuperType.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.LocatorSuperType.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.LocatorSuperType.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.LocatorSuperType.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.LocatorSuperType.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.LocatorSuperType.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.LocatorSuperType.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.LocatorSuperType.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.LocatorSuperType.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.LocatorSuperType.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.LocatorSuperType.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.LocatorSuperType.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.LocatorSuperType.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.LocatorSuperType.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.LocatorSuperType.scene

type: property

modo.scene.util.item.LocatorSuperType.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.LocatorSuperType.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.LocatorSuperType.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.LocatorSuperType.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.LocatorSuperType.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Matrix4

type: type

doc: Matrix class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4._getIdentity

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4._matrix_calcRotation

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4._matrix_vectorMultiply

type: function

doc: :param matrix: :param vector: :param result: :return:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4._MatrixToEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4._rotOrderToList

type: function

doc: takes a string in form of 'xyz' and returns a list in form of [0,1,2]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4.asEuler(self,degrees,order)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4.asRotateMatrix(self)

type: instancemethod

doc: Removes the translation part of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4.copy(self)

type: instancemethod

doc: :return: A copy of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4.determinant(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4.fromEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4.invert(self)

type: instancemethod

doc: Inverts this Matrix in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4.inverted(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4.position

type: property

doc: :getter: Returns the translation part of this matrix :rtype: tuple :setter: Sets the translation part of this matrix :param position: Position :type position: iterable

modo.scene.util.item.Matrix4.scale(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4.set(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4.setIdentity(self)

type: instancemethod

doc: Set this matrix to it's identity

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4.transpose(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Matrix4.transposed(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal. It returns a new transposed matrix.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Mesh

type: type

doc: Mesh item class. Takes an optional 'mesh' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'mesh' or an item name or ID to look up. If no mesh item is supplied as an argument an attempt will be made to wrap the most recently selected mesh layer. :param mesh: Optional mesh item object (type lx.symbol.sITYPE_MESH) or string (item name or ID) to look up. :type mesh: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid mesh item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'mesh' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the mesh argument but no item with that name/ID can be found. The mesh geometry can be accessed by the :class:`geometry` attribute. .. py:attribute:: geometry :rtype: :class:`MeshGeometry`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh._item

type: property

modo.scene.util.item.Mesh._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.Mesh.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.Mesh.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.Mesh.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.Mesh.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.geometry

type: property

modo.scene.util.item.Mesh.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.Mesh.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.Mesh.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.Mesh.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.Mesh.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.Mesh.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.Mesh.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.Mesh.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.Mesh.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.Mesh.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.Mesh.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Mesh.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Mesh.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Mesh.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Mesh.scene

type: property

modo.scene.util.item.Mesh.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.Mesh.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Mesh.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Mesh.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.Mesh.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.MeshGeometry

type: type

doc: A class wrapped around lx.object.Mesh that provides access to geometry of a given Mesh Item :param item: Input item :type item: type lx.object.Item :param mode: Mode in which to access the mesh. Possible values: "write", "read", "deformed" :type mode: string. Note: References are always read only. :return: Instance of MeshGeometry :raises LookupError: If item was passed as string and could not be found in the scene :raises TypeError: If the passed item is not of type lx.object.Item :raises TypeError: If the passed item is not compatible with the mesh type example:: scene = modo.scene.current() # Get the selected mesh for mesh in scene.selectedByType("mesh")[:1]: # Print the number of vertices print len(mesh.geometry.vertices) # Print point position by index print mesh.geometry.vertices[4] # Set point position by index mesh.geometry.vertices[4] = (1,2,3) # Iterate all vertices and move them by 0.1 in x for point in mesh.geometry.vertices: point += (0.1, 0, 0) # Update to see mesh changes mesh.geometry.setMeshEdits() .. py:attribute:: vertices :rtype: :class:`MeshVertices` .. py:attribute:: edges :rtype: :class:`MeshEdges` .. py:attribute:: polygons :rtype: :class:`MeshPolygons` .. py:attribute:: vmaps :rtype: :class:`MeshMaps`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.scene.util.item.MeshGeometry._item

type: property

modo.scene.util.item.MeshGeometry._SEL_SVC

type: Selection

modo.scene.util.item.MeshGeometry._UNDO_SVC

type: Undo

modo.scene.util.item.MeshGeometry.accessMode

type: property

modo.scene.util.item.MeshGeometry.boundingBox

type: property

doc: Get the bounding box of this mesh :getter: Returns a tuple representing the two corners of the bounding box

modo.scene.util.item.MeshGeometry.getMeshCenter(self)

type: instancemethod

doc: :return: Center position of the bounding box

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.scene.util.item.MeshGeometry.internalMesh

type: property

doc: :getter: Returns the wrapped lx.object.Mesh object

modo.scene.util.item.MeshGeometry.numEdges

type: property

doc: :getter: returns the vertex count of this mesh

modo.scene.util.item.MeshGeometry.numPolygons

type: property

doc: :getter: returns the polygon count of this mesh

modo.scene.util.item.MeshGeometry.numVertices

type: property

doc: :getter: returns the vertex count of this mesh

modo.scene.util.item.MeshGeometry.setAccessMode(self,value,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.scene.util.item.MeshGeometry.setMeshEdits(self,editType)

type: instancemethod

doc: Updates mesh edits applying previous changes. :param lx.symbol.f_MESHEDIT_* editType: The type of change to set. Defaults to all.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.scene.util.item.PhotometricLight

type: type

doc: Photometric (ies) light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Photometric Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Photometric Light item. :param light: Optional Photometric light item object (type lx.symbol.sITYPE_PHOTOMETRYLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Photometric light item selected. :raises TypeError: if the item passed as an argument isn't either a Photometric light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight._item

type: property

modo.scene.util.item.PhotometricLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.PhotometricLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.PhotometricLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.PhotometricLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.PhotometricLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.PhotometricLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.PhotometricLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.PhotometricLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.PhotometricLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.PhotometricLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.PhotometricLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.util.item.PhotometricLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.PhotometricLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.PhotometricLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.PhotometricLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.PhotometricLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.PhotometricLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.PhotometricLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.PhotometricLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.PhotometricLight.scene

type: property

modo.scene.util.item.PhotometricLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.PhotometricLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PhotometricLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.PhotometricLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.PhotometricLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.PointLight

type: type

doc: Point light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Point Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Point Light item. :param light: Optional Point light item object (type lx.symbol.sITYPE_POINTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Point light item selected. :raises TypeError: if the item passed as an argument isn't either a Point light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight._item

type: property

modo.scene.util.item.PointLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.PointLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.PointLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.PointLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.PointLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.PointLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.PointLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.PointLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.PointLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.PointLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.PointLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.util.item.PointLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.PointLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.PointLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.PointLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.PointLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.PointLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.PointLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.PointLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.PointLight.scene

type: property

modo.scene.util.item.PointLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.PointLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.PointLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.PointLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.PointLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Portal

type: type

doc: Portal item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Portal' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Portal item. :param light: Optional Portal item object (type 'portal') or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Portal item selected. :raises TypeError: if the item passed as an argument isn't either a Portal item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal._item

type: property

modo.scene.util.item.Portal._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.Portal.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.Portal.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.Portal.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.Portal.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.Portal.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.Portal.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.Portal.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.Portal.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.Portal.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.Portal.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.util.item.Portal.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.Portal.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.Portal.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.Portal.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.Portal.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Portal.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Portal.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Portal.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.Portal.scene

type: property

modo.scene.util.item.Portal.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.Portal.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.Portal.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.Portal.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.Portal.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.RenderPassGroup

type: type

doc: Render pass group :param groupItem: either a group item or an item name/ID to look up. :type groupItem: lx.object.item or modo.item.Item :raises TypeError: if the item is not a 'Group" item. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup._item

type: property

modo.scene.util.item.RenderPassGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.addPass(self,name)

type: instancemethod

doc: Add a render pass item to the group. :param name: optional name for the render pass :type name: basestring :return: the render pass item. :rtype: modo.item.ActionClip

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.RenderPassGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.RenderPassGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.RenderPassGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.RenderPassGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.scene.util.item.RenderPassGroup.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.scene.util.item.RenderPassGroup.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.RenderPassGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.RenderPassGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.RenderPassGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.RenderPassGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.scene.util.item.RenderPassGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.RenderPassGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.RenderPassGroup.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.scene.util.item.RenderPassGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.RenderPassGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.RenderPassGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.RenderPassGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.RenderPassGroup.passes

type: property

doc: :getter: Returns a lst of render passes in the group. :returns: list of render pass items :rtype: list of modo.item.ActionClip

modo.scene.util.item.RenderPassGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.scene

type: property

modo.scene.util.item.RenderPassGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.RenderPassGroup.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.RenderPassGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.RenderPassGroup.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.scene.util.item.scene

type: module

doc: .. module:: modo.scene :synopsis: Scene class and scene level utility functions. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.scene.util.item.SpotLight

type: type

doc: Spotlight item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Spotlight' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Spotlight item. :param light: Optional Spotlight item object (type lx.symbol.sITYPE_SPOTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Spotlight item selected. :raises TypeError: if the item passed as an argument isn't either a Spotlight item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight._item

type: property

modo.scene.util.item.SpotLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.SpotLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.SpotLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.SpotLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.SpotLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.SpotLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.SpotLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.SpotLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.SpotLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.SpotLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.SpotLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.scene.util.item.SpotLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.SpotLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.SpotLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.SpotLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.SpotLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.SpotLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.SpotLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.SpotLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.SpotLight.scene

type: property

modo.scene.util.item.SpotLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.SpotLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.SpotLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.SpotLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.SpotLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.TextureLocator

type: type

doc: Texture locator item class. Takes an optional 'texloc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Texture locator' or an item name or ID to look up. If no texloc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param texloc: Optional texture locator item object (type lx.symbol.sITYPE_TEXTURELOC) or string (item name or ID) to look up. :type texloc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid texture locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'texture locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the texloc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator._item

type: property

modo.scene.util.item.TextureLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.TextureLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.TextureLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.TextureLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.TextureLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.TextureLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.TextureLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.TextureLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.TextureLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.TextureLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.TextureLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.TextureLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.TextureLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.TextureLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.TextureLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.TextureLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.TextureLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.TextureLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.TextureLocator.scene

type: property

modo.scene.util.item.TextureLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.TextureLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TextureLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.TextureLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.TextureLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.TransformItem

type: type

doc: Contains a group of animatable transform channels of a locator object. It has convenience functions for access of the locator's position, rotation and scale. examples:: # We retrieve two meshes from the current scene by name, assuming they exist cube = modo.Mesh('Cube') sphere = modo.Mesh('Sphere') # Set rotation values cube.rotation.set(10, 20, 30, degrees=True) # Link the position.x channel of the sphere to to the position.x channel of the cube cube.position.y.setLink(0, sphere.position.x, 0) # Set position values to zero cube.position.clear() # Insert keyframe for rotation on frame 21 frame = lx.service.Value().FrameToTime(21) cube.rotation.insertKey(time=frame)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem._item

type: property

modo.scene.util.item.TransformItem._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem._TransformItem__rotationType

type: long

modo.scene.util.item.TransformItem._TransformItem__scaleType

type: long

modo.scene.util.item.TransformItem._TransformItem__toDegrees

type: function

doc: Utility function to consume and process the 'degrees' argument for the set function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem._TransformItem__transformType(self)

type: instancemethod

doc: Utility function that returns the corresponding string value from __types, for later channel lookup

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem._TransformItem__translationType

type: long
modo.scene.util.item.TransformItem._TransformItem__types type: dict

modo.scene.util.item.TransformItem._TransformItem__types.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.scene.util.item.TransformItem._TransformItem__types.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.scene.util.item.TransformItem._TransformItem__types.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.scene.util.item.TransformItem._TransformItem__types.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.scene.util.item.TransformItem._TransformItem__types.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.scene.util.item.TransformItem._TransformItem__types.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.scene.util.item.TransformItem._TransformItem__types.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.scene.util.item.TransformItem._TransformItem__types.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.scene.util.item.TransformItem._TransformItem__types.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.scene.util.item.TransformItem._TransformItem__types.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.scene.util.item.TransformItem._TransformItem__types.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.scene.util.item.TransformItem._TransformItem__types.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.scene.util.item.TransformItem._TransformItem__types.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.scene.util.item.TransformItem._TransformItem__types.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.scene.util.item.TransformItem._TransformItem__types.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.scene.util.item.TransformItem._TransformItem__types.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.scene.util.item.TransformItem._TransformItem__types.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.scene.util.item.TransformItem._TransformItem__types.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.scene.util.item.TransformItem.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.TransformItem.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.TransformItem.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.clear(self)

type: instancemethod

doc: Sets values to 1.0 if is a scaling transform and to 0.0 otherwise :param arguments: Same as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.TransformItem.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.TransformItem.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.get(self,time,action,degrees)

type: instancemethod

doc: Function to get the x, y and z-values of the locator at once. :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when getting rotation. :param keywords: Same as as :meth:`Channel.get` :returns tuple: x, y and z values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.TransformItem.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.TransformItem.insertKey(self,time,action)

type: instancemethod

doc: Inserts a keyframe on the respective x, y and z channels. :param float time: Time in seconds to create the new keys :param action: Action to create keys in.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.TransformItem.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.TransformItem.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.TransformItem.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.TransformItem.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.TransformItem.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.TransformItem.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.TransformItem.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.TransformItem.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.removeKey(self,time,action)

type: instancemethod

doc:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.scene

type: property

modo.scene.util.item.TransformItem.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.TransformItem.set(self,values,time,key,action,degrees)

type: instancemethod

doc: Function to set the x, y and z-values of the locator at once. :param values: either three floats, or a list/tuple containing the x, y, z values to set :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when setting rotation. :param keywords: Same as as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItem.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.TransformItem.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.TransformItem.x

type: property

doc: Shortcut to the x channel of the locator :getter: :class:`Channel` :rtype: float

modo.scene.util.item.TransformItem.y

type: property

doc: Shortcut to the y channel of the locator :getter: :class:`Channel` :rtype: float

modo.scene.util.item.TransformItem.z

type: property

doc: Shortcut to the z channel of the locator :getter: :class:`Channel` :rtype: float

modo.scene.util.item.TransformItems

type: type

doc: Container class for the stacked transform items of a Locator object. Transform items contain channels for either position, rotation or scale. The order of how they are processed can be changed and new transform items can be inserted or existing ones deleted. example:: scene = modo.scene.current() # Grab first selected object for item in scene.selected[:1]: # Print the amount of transform items print len(item.transforms) # Add a new position transform item position = item.transforms.insert('position', values=(1,0,0), name='New_Position') # Add a new scale transform item scale = item.transforms.insert('scale', values=(2,2,2), name='Scaled') # Swap the indices of the first two transform items item.transforms.reposition(0,1) # Delete item.transforms.delete(scale) # Clear values of all transforms for i in item.transforms: i.clear()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems._item

type: property

modo.scene.util.item.TransformItems._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.scene.util.item.TransformItems.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.scene.util.item.TransformItems.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.scene.util.item.TransformItems.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.scene.util.item.TransformItems.delete(self,index)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.scene.util.item.TransformItems.idNames(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.scene.util.item.TransformItems.insert(self,xfrmType,placement,values,name)

type: instancemethod

doc: Insert a new transform item into the transform chain. The 'prepend' and 'append' placement values place the new item at the top or bottom of the stack, where 'pre' and 'post' place it around the respective transform highlighted in black in the channel view. I am myself confused about the order though, is it bottom to top or the other way around? Note that modo always keeps at least one of each type of transform, so when you attempt to delete it a new one is created automatically. :param string xfrmType: 'position', 'rotation' or 'scale' :param string placement: 'prepend', 'append', 'pre' or 'post' :param tuple values: Initial xyz values to be optionally set :param string name: Optional name

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.scene.util.item.TransformItems.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.scene.util.item.TransformItems.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.scene.util.item.TransformItems.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.scene.util.item.TransformItems.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.scene.util.item.TransformItems.names(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.scene.util.item.TransformItems.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.scene.util.item.TransformItems.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.scene.util.item.TransformItems.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.TransformItems.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.TransformItems.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.reposition(self,indexFrom,indexTo)

type: instancemethod

doc: Places a transform item to the provided index of the transform item stack :param int indexFrom: Source Index of the item that is to be moved :param int indexTo: Destination index to place item at

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.TransformItems.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.scene.util.item.TransformItems.scene

type: property

modo.scene.util.item.TransformItems.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.scene.util.item.TransformItems.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.scene.util.item.TransformItems.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.TransformItems.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.scene.util.item.TransformItems.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.scene.util.item.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.util.item.Vector3

type: type

doc: Vector3 class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.angle(self,other)

type: instancemethod

doc: Returns the angle between this and another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.copy(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.cross(self,other)

type: instancemethod

doc: Returns a new vector with the result of crossing this vector with another

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.distanceBetweenPoints(self,other)

type: instancemethod

doc: Returns the distance between this and another point

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.dot(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.equals(self,other,tolerance)

type: instancemethod

doc: Returns if this vector is equivalent to another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.length(self)

type: instancemethod

doc: Returns the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.mulByMatrixAsPoint(self,other)

type: instancemethod

doc: Transform this point's position by a Matrix4 in place. :param Matrix4 other: Other Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.normal(self)

type: instancemethod

doc: Returns a normalized copy of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.normalize(self)

type: instancemethod

doc: Normalizes this vector in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.rotate(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.rotateByAxisAngle(self,axis,angle)

type: instancemethod

doc: Rotates this vector by a given axis and angle :param Vector3 axis: This axis to rotate about :param float angle: The angle in radians to rotate by

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.rotateByQuat(self,other)

type: instancemethod

doc: Rotate this vector by a quaternion

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.setLength(self,value)

type: instancemethod

doc: Sets the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.scene.util.item.Vector3.x

type: property

doc: Quick access to the x component of the vector

modo.scene.util.item.Vector3.y

type: property

doc: Quick access to the y component of the vector

modo.scene.util.item.Vector3.z

type: property

doc: Quick access to the z component of the vector

modo.scene.util.makeQuickCommand

type: function

doc: Quick way to create a command. Note that a command can only be blessed (registered) once per modo session, so this command will fail when attempting to rebless a command. :param string name: Name that the command will be callable by. Example: cmds.myCommand :param function func: The function that the command should call :param iterable arguments: A sequence of name:defaultvalue pairs to make arguments that will be passed on to the function :param basestring userName: The user name :param basestring description: Summary of the command's purpose :param basestring toolTip: Text that appears when hovering over the button example:: import modo def func_args(mystring, myint): print mystring, myint def func_simple(): print 'simple function, no arguments' modo.util.makeQuickCommand('test.simple', func_simple) modo.util.makeQuickCommand('test.args', func_args, (('mystring', 'mesh021'), ('myint', 23))) lx.eval('test.simple') lx.eval('test.args mesh022 24')

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.util.paths

type: function

doc: Access to various system paths. :param basestring key: Specific path to return. Returns all if None. :returns dictionary or string: Dictionary containing all paths or single path as string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.util.testGlobalInterpreter

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.scene.util.typeToFunc

type: function

doc: selects an item class constructor based on the item type passed as an argument and returns that as a class instantiation 'function' object to call the correct class in methods that eg select by item type or return items. In essence it acts as a sort of clearing house to try to ensure that any recognised but unwrapped items are wrapped with the correct modo.item.xxx type before being returned. example usage:: # get a list of all the light items in a scene where each light in the list is returned as the correctly # wrapped modo version of each light sub-type. import modo scene = modo.Scene() lights = [] for light in scene.ItemList(modo.c.LIGHT_TYPE): func = modo.c.typeToFunc(light.Type()) lights.append(func(light)) # or more succinctly as a list comprehension: lights = [modo.c.typeToFunc(light.Type())(light) for light in scene.ItemList(modo.c.LIGHT_TYPE)]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.sceneList

type: function

doc: Get a list of all the currently open scenes. :returns: Collection of currently open scenes as modo.scene.Scene objects. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.SpotLight

type: type

doc: Spotlight item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Spotlight' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Spotlight item. :param light: Optional Spotlight item object (type lx.symbol.sITYPE_SPOTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Spotlight item selected. :raises TypeError: if the item passed as an argument isn't either a Spotlight item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight._item

type: property

modo.SpotLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.SpotLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.SpotLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.SpotLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.SpotLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.SpotLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.SpotLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.SpotLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.SpotLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.SpotLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.SpotLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.SpotLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.SpotLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.SpotLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.SpotLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.SpotLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.SpotLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.SpotLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.SpotLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.SpotLight.scene

type: property

modo.SpotLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.SpotLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.SpotLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.SpotLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.SpotLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.TextureLocator

type: type

doc: Texture locator item class. Takes an optional 'texloc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Texture locator' or an item name or ID to look up. If no texloc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param texloc: Optional texture locator item object (type lx.symbol.sITYPE_TEXTURELOC) or string (item name or ID) to look up. :type texloc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid texture locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'texture locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the texloc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator._item

type: property

modo.TextureLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.TextureLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.TextureLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.TextureLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.TextureLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.TextureLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.TextureLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.TextureLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.TextureLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.TextureLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.TextureLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.TextureLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.TextureLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.TextureLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.TextureLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.TextureLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.TextureLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.TextureLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.TextureLocator.scene

type: property

modo.TextureLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.TextureLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TextureLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.TextureLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.TextureLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.TransformItem

type: type

doc: Contains a group of animatable transform channels of a locator object. It has convenience functions for access of the locator's position, rotation and scale. examples:: # We retrieve two meshes from the current scene by name, assuming they exist cube = modo.Mesh('Cube') sphere = modo.Mesh('Sphere') # Set rotation values cube.rotation.set(10, 20, 30, degrees=True) # Link the position.x channel of the sphere to to the position.x channel of the cube cube.position.y.setLink(0, sphere.position.x, 0) # Set position values to zero cube.position.clear() # Insert keyframe for rotation on frame 21 frame = lx.service.Value().FrameToTime(21) cube.rotation.insertKey(time=frame)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem._item

type: property

modo.TransformItem._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem._TransformItem__rotationType

type: long

modo.TransformItem._TransformItem__scaleType

type: long

modo.TransformItem._TransformItem__toDegrees

type: function

doc: Utility function to consume and process the 'degrees' argument for the set function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem._TransformItem__transformType(self)

type: instancemethod

doc: Utility function that returns the corresponding string value from __types, for later channel lookup

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem._TransformItem__translationType

type: long
modo.TransformItem._TransformItem__types
type: dict

modo.TransformItem._TransformItem__types.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.TransformItem._TransformItem__types.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.TransformItem._TransformItem__types.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.TransformItem._TransformItem__types.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.TransformItem._TransformItem__types.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.TransformItem._TransformItem__types.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.TransformItem._TransformItem__types.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.TransformItem._TransformItem__types.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.TransformItem._TransformItem__types.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.TransformItem._TransformItem__types.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.TransformItem._TransformItem__types.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.TransformItem._TransformItem__types.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.TransformItem._TransformItem__types.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.TransformItem._TransformItem__types.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.TransformItem._TransformItem__types.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.TransformItem._TransformItem__types.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.TransformItem._TransformItem__types.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.TransformItem._TransformItem__types.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.TransformItem.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.TransformItem.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.TransformItem.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.clear(self)

type: instancemethod

doc: Sets values to 1.0 if is a scaling transform and to 0.0 otherwise :param arguments: Same as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.TransformItem.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.TransformItem.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.get(self,time,action,degrees)

type: instancemethod

doc: Function to get the x, y and z-values of the locator at once. :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when getting rotation. :param keywords: Same as as :meth:`Channel.get` :returns tuple: x, y and z values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.TransformItem.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.TransformItem.insertKey(self,time,action)

type: instancemethod

doc: Inserts a keyframe on the respective x, y and z channels. :param float time: Time in seconds to create the new keys :param action: Action to create keys in.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.TransformItem.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.TransformItem.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.TransformItem.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.TransformItem.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.TransformItem.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.TransformItem.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.TransformItem.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.TransformItem.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.removeKey(self,time,action)

type: instancemethod

doc:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.scene

type: property

modo.TransformItem.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.TransformItem.set(self,values,time,key,action,degrees)

type: instancemethod

doc: Function to set the x, y and z-values of the locator at once. :param values: either three floats, or a list/tuple containing the x, y, z values to set :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when setting rotation. :param keywords: Same as as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItem.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.TransformItem.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.TransformItem.x

type: property

doc: Shortcut to the x channel of the locator :getter: :class:`Channel` :rtype: float

modo.TransformItem.y

type: property

doc: Shortcut to the y channel of the locator :getter: :class:`Channel` :rtype: float

modo.TransformItem.z

type: property

doc: Shortcut to the z channel of the locator :getter: :class:`Channel` :rtype: float

modo.TransformItems

type: type

doc: Container class for the stacked transform items of a Locator object. Transform items contain channels for either position, rotation or scale. The order of how they are processed can be changed and new transform items can be inserted or existing ones deleted. example:: scene = modo.scene.current() # Grab first selected object for item in scene.selected[:1]: # Print the amount of transform items print len(item.transforms) # Add a new position transform item position = item.transforms.insert('position', values=(1,0,0), name='New_Position') # Add a new scale transform item scale = item.transforms.insert('scale', values=(2,2,2), name='Scaled') # Swap the indices of the first two transform items item.transforms.reposition(0,1) # Delete item.transforms.delete(scale) # Clear values of all transforms for i in item.transforms: i.clear()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems._item

type: property

modo.TransformItems._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.TransformItems.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.TransformItems.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.TransformItems.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.TransformItems.delete(self,index)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.TransformItems.idNames(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.TransformItems.insert(self,xfrmType,placement,values,name)

type: instancemethod

doc: Insert a new transform item into the transform chain. The 'prepend' and 'append' placement values place the new item at the top or bottom of the stack, where 'pre' and 'post' place it around the respective transform highlighted in black in the channel view. I am myself confused about the order though, is it bottom to top or the other way around? Note that modo always keeps at least one of each type of transform, so when you attempt to delete it a new one is created automatically. :param string xfrmType: 'position', 'rotation' or 'scale' :param string placement: 'prepend', 'append', 'pre' or 'post' :param tuple values: Initial xyz values to be optionally set :param string name: Optional name

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.TransformItems.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.TransformItems.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.TransformItems.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.TransformItems.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.TransformItems.names(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.TransformItems.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.TransformItems.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.TransformItems.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.TransformItems.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.TransformItems.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.reposition(self,indexFrom,indexTo)

type: instancemethod

doc: Places a transform item to the provided index of the transform item stack :param int indexFrom: Source Index of the item that is to be moved :param int indexTo: Destination index to place item at

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.TransformItems.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.TransformItems.scene

type: property

modo.TransformItems.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.TransformItems.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.TransformItems.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.TransformItems.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.TransformItems.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.util.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.util.collections

type: module

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.util.collections._abcoll

type: module

doc: Abstract Base Classes (ABCs) for collections, according to PEP 3119. DON'T USE THIS MODULE DIRECTLY! The classes here should be imported via collections; they are defined here only to alleviate certain bootstrapping issues. Unit tests are in test_collections.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll._hasattr

type: function

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.util.collections._abcoll.ABCMeta

type: type

doc: Metaclass for defining Abstract Base Classes (ABCs). Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as 'virtual subclasses' -- these and their descendants will be considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won't show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via super()).

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\abc.pyc

    modo.util.collections._abcoll.ABCMeta contents:
  • modo.util.collections._abcoll.ABCMeta.__base__
  • modo.util.collections._abcoll.ABCMeta.__bases__
  • modo.util.collections._abcoll.ABCMeta.__basicsize__
  • modo.util.collections._abcoll.ABCMeta.__call__
  • modo.util.collections._abcoll.ABCMeta.__class__
  • modo.util.collections._abcoll.ABCMeta.__delattr__
  • modo.util.collections._abcoll.ABCMeta.__dict__
  • modo.util.collections._abcoll.ABCMeta.__dictoffset__
  • modo.util.collections._abcoll.ABCMeta.__doc__
  • modo.util.collections._abcoll.ABCMeta.__eq__
  • modo.util.collections._abcoll.ABCMeta.__flags__
  • modo.util.collections._abcoll.ABCMeta.__format__
  • modo.util.collections._abcoll.ABCMeta.__ge__
  • modo.util.collections._abcoll.ABCMeta.__getattribute__
  • modo.util.collections._abcoll.ABCMeta.__gt__
  • modo.util.collections._abcoll.ABCMeta.__hash__
  • modo.util.collections._abcoll.ABCMeta.__init__
  • modo.util.collections._abcoll.ABCMeta.__instancecheck__
  • modo.util.collections._abcoll.ABCMeta.__itemsize__
  • modo.util.collections._abcoll.ABCMeta.__le__
  • modo.util.collections._abcoll.ABCMeta.__lt__
  • modo.util.collections._abcoll.ABCMeta.__module__
  • modo.util.collections._abcoll.ABCMeta.__mro__
  • modo.util.collections._abcoll.ABCMeta.__name__
  • modo.util.collections._abcoll.ABCMeta.__ne__
  • modo.util.collections._abcoll.ABCMeta.__new__
  • modo.util.collections._abcoll.ABCMeta.__reduce__
  • modo.util.collections._abcoll.ABCMeta.__reduce_ex__
  • modo.util.collections._abcoll.ABCMeta.__repr__
  • modo.util.collections._abcoll.ABCMeta.__setattr__
  • modo.util.collections._abcoll.ABCMeta.__sizeof__
  • modo.util.collections._abcoll.ABCMeta.__str__
  • modo.util.collections._abcoll.ABCMeta.__subclasscheck__
  • modo.util.collections._abcoll.ABCMeta.__subclasses__
  • modo.util.collections._abcoll.ABCMeta.__subclasshook__
  • modo.util.collections._abcoll.ABCMeta.__weakrefoffset__
  • modo.util.collections._abcoll.ABCMeta._abc_invalidation_counter
  • modo.util.collections._abcoll.ABCMeta._dump_registry
  • modo.util.collections._abcoll.ABCMeta.mro
  • modo.util.collections._abcoll.ABCMeta.register

modo.util.collections._abcoll.ABCMeta._abc_invalidation_counter

type: int

modo.util.collections._abcoll.ABCMeta._dump_registry(cls,file)

type: instancemethod

doc: Debug helper to print the ABC registry.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.util.collections._abcoll.ABCMeta.mro()

type: method_descriptor

doc: mro() -> list return a type's method resolution order

modo.util.collections._abcoll.ABCMeta.register(cls,subclass)

type: instancemethod

doc: Register a virtual subclass of an ABC.

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.util.collections._abcoll.abstractmethod

type: function

doc: A decorator indicating abstract methods. Requires that the metaclass is ABCMeta or derived from it. A class that has a metaclass derived from ABCMeta cannot be instantiated unless all of its abstract methods are overridden. The abstract methods can be called using any of the normal 'super' call mechanisms. Usage: class C: __metaclass__ = ABCMeta @abstractmethod def my_abstract_method(self, ...): ...

file: u:\Luxology\source\extra\python\python2.7\lib\abc.py

modo.util.collections._abcoll.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._abcoll.sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.util.collections._abcoll.sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.util.collections._abcoll.sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.util.collections._abcoll.sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.util.collections._abcoll.sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.util.collections._abcoll.sys.api_version

type: int

modo.util.collections._abcoll.sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.util.collections._abcoll.sys.byteorder

type: str

modo.util.collections._abcoll.sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.util.collections._abcoll.sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.util.collections._abcoll.sys.copyright

type: str

modo.util.collections._abcoll.sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.util.collections._abcoll.sys.dllhandle

type: long

modo.util.collections._abcoll.sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.util.collections._abcoll.sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.util.collections._abcoll.sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.util.collections._abcoll.sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.util.collections._abcoll.sys.exc_type

type: type

doc: Inappropriate argument type.

    modo.util.collections._abcoll.sys.exc_type contents:
  • modo.util.collections._abcoll.sys.exc_type.__class__
  • modo.util.collections._abcoll.sys.exc_type.__delattr__
  • modo.util.collections._abcoll.sys.exc_type.__dict__
  • modo.util.collections._abcoll.sys.exc_type.__doc__
  • modo.util.collections._abcoll.sys.exc_type.__format__
  • modo.util.collections._abcoll.sys.exc_type.__getattribute__
  • modo.util.collections._abcoll.sys.exc_type.__getitem__
  • modo.util.collections._abcoll.sys.exc_type.__getslice__
  • modo.util.collections._abcoll.sys.exc_type.__hash__
  • modo.util.collections._abcoll.sys.exc_type.__init__
  • modo.util.collections._abcoll.sys.exc_type.__new__
  • modo.util.collections._abcoll.sys.exc_type.__reduce__
  • modo.util.collections._abcoll.sys.exc_type.__reduce_ex__
  • modo.util.collections._abcoll.sys.exc_type.__repr__
  • modo.util.collections._abcoll.sys.exc_type.__setattr__
  • modo.util.collections._abcoll.sys.exc_type.__setstate__
  • modo.util.collections._abcoll.sys.exc_type.__sizeof__
  • modo.util.collections._abcoll.sys.exc_type.__str__
  • modo.util.collections._abcoll.sys.exc_type.__subclasshook__
  • modo.util.collections._abcoll.sys.exc_type.__unicode__
  • modo.util.collections._abcoll.sys.exc_type.args
  • modo.util.collections._abcoll.sys.exc_type.message

modo.util.collections._abcoll.sys.exc_type.args

type: getset_descriptor

modo.util.collections._abcoll.sys.exc_type.message

type: getset_descriptor

modo.util.collections._abcoll.sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.util.collections._abcoll.sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.util.collections._abcoll.sys.exec_prefix

type: str

modo.util.collections._abcoll.sys.executable

type: str

modo.util.collections._abcoll.sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.util.collections._abcoll.sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.util.collections._abcoll.sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.util.collections._abcoll.sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.util.collections._abcoll.sys.float_repr_style

type: str

modo.util.collections._abcoll.sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.util.collections._abcoll.sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.util.collections._abcoll.sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.util.collections._abcoll.sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.util.collections._abcoll.sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.util.collections._abcoll.sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.util.collections._abcoll.sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.util.collections._abcoll.sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.util.collections._abcoll.sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.util.collections._abcoll.sys.hexversion

type: int

modo.util.collections._abcoll.sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.util.collections._abcoll.sys.maxint

type: int

modo.util.collections._abcoll.sys.maxsize

type: long

modo.util.collections._abcoll.sys.maxunicode

type: int

modo.util.collections._abcoll.sys.meta_path

type: list
modo.util.collections._abcoll.sys.modules type: dict

modo.util.collections._abcoll.sys.modules.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.util.collections._abcoll.sys.modules.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.util.collections._abcoll.sys.modules.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.util.collections._abcoll.sys.modules.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.util.collections._abcoll.sys.modules.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.util.collections._abcoll.sys.modules.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.util.collections._abcoll.sys.modules.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.util.collections._abcoll.sys.modules.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.util.collections._abcoll.sys.modules.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.util.collections._abcoll.sys.modules.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.util.collections._abcoll.sys.modules.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.util.collections._abcoll.sys.modules.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.util.collections._abcoll.sys.modules.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.util.collections._abcoll.sys.modules.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.util.collections._abcoll.sys.modules.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.util.collections._abcoll.sys.modules.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.util.collections._abcoll.sys.modules.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.util.collections._abcoll.sys.modules.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.util.collections._abcoll.sys.path

type: list

modo.util.collections._abcoll.sys.path_hooks

type: list
modo.util.collections._abcoll.sys.path_importer_cache type: dict

modo.util.collections._abcoll.sys.path_importer_cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.util.collections._abcoll.sys.path_importer_cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.util.collections._abcoll.sys.path_importer_cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.util.collections._abcoll.sys.path_importer_cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.util.collections._abcoll.sys.path_importer_cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.util.collections._abcoll.sys.path_importer_cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.util.collections._abcoll.sys.path_importer_cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.util.collections._abcoll.sys.path_importer_cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.util.collections._abcoll.sys.path_importer_cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.util.collections._abcoll.sys.path_importer_cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.util.collections._abcoll.sys.path_importer_cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.util.collections._abcoll.sys.path_importer_cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.util.collections._abcoll.sys.path_importer_cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.util.collections._abcoll.sys.path_importer_cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.util.collections._abcoll.sys.path_importer_cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.util.collections._abcoll.sys.path_importer_cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.util.collections._abcoll.sys.path_importer_cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.util.collections._abcoll.sys.path_importer_cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.util.collections._abcoll.sys.platform

type: str

modo.util.collections._abcoll.sys.prefix

type: str

modo.util.collections._abcoll.sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.util.collections._abcoll.sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.util.collections._abcoll.sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.util.collections._abcoll.sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.util.collections._abcoll.sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.util.collections._abcoll.sys.stderr

type: SESysStdErr

modo.util.collections._abcoll.sys.stdin

type: SESysStdIn

modo.util.collections._abcoll.sys.stdout

type: SESysStdOut

modo.util.collections._abcoll.sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.util.collections._abcoll.sys.version

type: str

modo.util.collections._abcoll.sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.util.collections._abcoll.sys.warnoptions

type: list

modo.util.collections._abcoll.sys.winver

type: str

modo.util.collections._abcoll.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections._chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.util.collections._chain contents:
  • modo.util.collections._chain.__class__
  • modo.util.collections._chain.__delattr__
  • modo.util.collections._chain.__doc__
  • modo.util.collections._chain.__format__
  • modo.util.collections._chain.__getattribute__
  • modo.util.collections._chain.__hash__
  • modo.util.collections._chain.__init__
  • modo.util.collections._chain.__iter__
  • modo.util.collections._chain.__new__
  • modo.util.collections._chain.__reduce__
  • modo.util.collections._chain.__reduce_ex__
  • modo.util.collections._chain.__repr__
  • modo.util.collections._chain.__setattr__
  • modo.util.collections._chain.__sizeof__
  • modo.util.collections._chain.__str__
  • modo.util.collections._chain.__subclasshook__
  • modo.util.collections._chain.from_iterable
  • modo.util.collections._chain.next

modo.util.collections._chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.util.collections._chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.util.collections._get_ident()

type: builtin_function_or_method

doc: get_ident() -> integer Return a non-zero integer that uniquely identifies the current thread amongst other threads that exist simultaneously. This may be used to identify per-thread resources. Even though on some platforms threads identities may appear to be allocated consecutive numbers starting at 1, this behavior should not be relied upon, and the number should be seen purely as a magic cookie. A thread's identity may be reused for another thread after it exits.

modo.util.collections._heapq

type: module

doc: Heap queue algorithm (a.k.a. priority queue). Heaps are arrays for which a[k] <= a[2*k+1] and a[k] <= a[2*k+2] for all k, counting elements from 0. For the sake of comparison, non-existing elements are considered to be infinite. The interesting property of a heap is that a[0] is always its smallest element. Usage: heap = [] # creates an empty heap heappush(heap, item) # pushes a new item on the heap item = heappop(heap) # pops the smallest item from the heap item = heap[0] # smallest item on the heap without popping it heapify(x) # transforms list into a heap, in-place, in linear time item = heapreplace(heap, item) # pops and returns smallest item, and adds # new item; the heap size is unchanged Our API differs from textbook heap algorithms as follows: - We use 0-based indexing. This makes the relationship between the index for a node and the indexes for its children slightly less obvious, but is more suitable since Python uses 0-based indexing. - Our heappop() method returns the smallest item, not the largest. These two make it possible to view the heap as a regular Python list without surprises: heap[0] is the smallest item, and heap.sort() maintains the heap invariant!

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\heapq.pyc

modo.util.collections._heapq._nlargest()

type: builtin_function_or_method

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, reverse=True)[:n]

modo.util.collections._heapq._nsmallest()

type: builtin_function_or_method

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable)[:n]

modo.util.collections._heapq._siftdown

type: function

file: .\Lib\heapq.py

modo.util.collections._heapq._siftup

type: function

file: .\Lib\heapq.py

modo.util.collections._heapq.bisect

type: module

doc: Bisection algorithms.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\bisect.pyc

modo.util.collections._heapq.bisect.bisect()

type: builtin_function_or_method

doc: Alias for bisect_right().

modo.util.collections._heapq.bisect.bisect_left()

type: builtin_function_or_method

doc: bisect_left(a, x[, lo[, hi]]) -> index Return the index where to insert item x in list a, assuming a is sorted. The return value i is such that all e in a[:i] have e < x, and all e in a[i:] have e >= x. So if x already appears in the list, i points just before the leftmost x already there. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.util.collections._heapq.bisect.bisect_right()

type: builtin_function_or_method

doc: bisect_right(a, x[, lo[, hi]]) -> index Return the index where to insert item x in list a, assuming a is sorted. The return value i is such that all e in a[:i] have e <= x, and all e in a[i:] have e > x. So if x already appears in the list, i points just beyond the rightmost x already there Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.util.collections._heapq.bisect.insort()

type: builtin_function_or_method

doc: Alias for insort_right().

modo.util.collections._heapq.bisect.insort_left()

type: builtin_function_or_method

doc: insort_left(a, x[, lo[, hi]]) Insert item x in list a, and keep it sorted assuming a is sorted. If x is already in a, insert it to the left of the leftmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.util.collections._heapq.bisect.insort_right()

type: builtin_function_or_method

doc: insort_right(a, x[, lo[, hi]]) Insert item x in list a, and keep it sorted assuming a is sorted. If x is already in a, insert it to the right of the rightmost x. Optional args lo (default 0) and hi (default len(a)) bound the slice of a to be searched.

modo.util.collections._heapq.chain

type: type

doc: chain(*iterables) --> chain object Return a chain object whose .next() method returns elements from the first iterable until it is exhausted, then elements from the next iterable, until all of the iterables are exhausted.

    modo.util.collections._heapq.chain contents:
  • modo.util.collections._heapq.chain.__class__
  • modo.util.collections._heapq.chain.__delattr__
  • modo.util.collections._heapq.chain.__doc__
  • modo.util.collections._heapq.chain.__format__
  • modo.util.collections._heapq.chain.__getattribute__
  • modo.util.collections._heapq.chain.__hash__
  • modo.util.collections._heapq.chain.__init__
  • modo.util.collections._heapq.chain.__iter__
  • modo.util.collections._heapq.chain.__new__
  • modo.util.collections._heapq.chain.__reduce__
  • modo.util.collections._heapq.chain.__reduce_ex__
  • modo.util.collections._heapq.chain.__repr__
  • modo.util.collections._heapq.chain.__setattr__
  • modo.util.collections._heapq.chain.__sizeof__
  • modo.util.collections._heapq.chain.__str__
  • modo.util.collections._heapq.chain.__subclasshook__
  • modo.util.collections._heapq.chain.from_iterable
  • modo.util.collections._heapq.chain.next

modo.util.collections._heapq.chain.from_iterable()

type: builtin_function_or_method

doc: chain.from_iterable(iterable) --> chain object Alternate chain() contructor taking a single iterable argument that evaluates lazily.

modo.util.collections._heapq.chain.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.util.collections._heapq.cmp_lt

type: function

file: .\Lib\heapq.py

modo.util.collections._heapq.count

type: type

doc: count(start=0, step=1) --> count object Return a count object whose .next() method returns consecutive values. Equivalent to: def count(firstval=0, step=1): x = firstval while 1: yield x x += step

    modo.util.collections._heapq.count contents:
  • modo.util.collections._heapq.count.__class__
  • modo.util.collections._heapq.count.__delattr__
  • modo.util.collections._heapq.count.__doc__
  • modo.util.collections._heapq.count.__format__
  • modo.util.collections._heapq.count.__getattribute__
  • modo.util.collections._heapq.count.__hash__
  • modo.util.collections._heapq.count.__init__
  • modo.util.collections._heapq.count.__iter__
  • modo.util.collections._heapq.count.__new__
  • modo.util.collections._heapq.count.__reduce__
  • modo.util.collections._heapq.count.__reduce_ex__
  • modo.util.collections._heapq.count.__repr__
  • modo.util.collections._heapq.count.__setattr__
  • modo.util.collections._heapq.count.__sizeof__
  • modo.util.collections._heapq.count.__str__
  • modo.util.collections._heapq.count.__subclasshook__
  • modo.util.collections._heapq.count.next

modo.util.collections._heapq.count.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.util.collections._heapq.heapify()

type: builtin_function_or_method

doc: Transform list into a heap, in-place, in O(len(heap)) time.

modo.util.collections._heapq.heappop()

type: builtin_function_or_method

doc: Pop the smallest item off the heap, maintaining the heap invariant.

modo.util.collections._heapq.heappush()

type: builtin_function_or_method

doc: Push item onto heap, maintaining the heap invariant.

modo.util.collections._heapq.heappushpop()

type: builtin_function_or_method

doc: Push item on the heap, then pop and return the smallest item from the heap. The combined action runs more efficiently than heappush() followed by a separate call to heappop().

modo.util.collections._heapq.heapreplace()

type: builtin_function_or_method

doc: Pop and return the current smallest value, and add the new item. This is more efficient than heappop() followed by heappush(), and can be more appropriate when using a fixed-size heap. Note that the value returned may be larger than item! That constrains reasonable uses of this routine unless written as part of a conditional replacement: if item > heap[0]: item = heapreplace(heap, item)

modo.util.collections._heapq.imap

type: type

doc: imap(func, *iterables) --> imap object Make an iterator that computes the function using arguments from each of the iterables. Like map() except that it returns an iterator instead of a list and that it stops when the shortest iterable is exhausted instead of filling in None for shorter iterables.

    modo.util.collections._heapq.imap contents:
  • modo.util.collections._heapq.imap.__class__
  • modo.util.collections._heapq.imap.__delattr__
  • modo.util.collections._heapq.imap.__doc__
  • modo.util.collections._heapq.imap.__format__
  • modo.util.collections._heapq.imap.__getattribute__
  • modo.util.collections._heapq.imap.__hash__
  • modo.util.collections._heapq.imap.__init__
  • modo.util.collections._heapq.imap.__iter__
  • modo.util.collections._heapq.imap.__new__
  • modo.util.collections._heapq.imap.__reduce__
  • modo.util.collections._heapq.imap.__reduce_ex__
  • modo.util.collections._heapq.imap.__repr__
  • modo.util.collections._heapq.imap.__setattr__
  • modo.util.collections._heapq.imap.__sizeof__
  • modo.util.collections._heapq.imap.__str__
  • modo.util.collections._heapq.imap.__subclasshook__
  • modo.util.collections._heapq.imap.next

modo.util.collections._heapq.imap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.util.collections._heapq.islice

type: type

doc: islice(iterable, [start,] stop [, step]) --> islice object Return an iterator whose next() method returns selected values from an iterable. If start is specified, will skip all preceding elements; otherwise, start defaults to zero. Step defaults to one. If specified as another value, step determines how many values are skipped between successive calls. Works like a slice() on a list but returns an iterator.

    modo.util.collections._heapq.islice contents:
  • modo.util.collections._heapq.islice.__class__
  • modo.util.collections._heapq.islice.__delattr__
  • modo.util.collections._heapq.islice.__doc__
  • modo.util.collections._heapq.islice.__format__
  • modo.util.collections._heapq.islice.__getattribute__
  • modo.util.collections._heapq.islice.__hash__
  • modo.util.collections._heapq.islice.__init__
  • modo.util.collections._heapq.islice.__iter__
  • modo.util.collections._heapq.islice.__new__
  • modo.util.collections._heapq.islice.__reduce__
  • modo.util.collections._heapq.islice.__reduce_ex__
  • modo.util.collections._heapq.islice.__repr__
  • modo.util.collections._heapq.islice.__setattr__
  • modo.util.collections._heapq.islice.__sizeof__
  • modo.util.collections._heapq.islice.__str__
  • modo.util.collections._heapq.islice.__subclasshook__
  • modo.util.collections._heapq.islice.next

modo.util.collections._heapq.islice.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.util.collections._heapq.itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.util.collections._heapq.itemgetter contents:
  • modo.util.collections._heapq.itemgetter.__call__
  • modo.util.collections._heapq.itemgetter.__class__
  • modo.util.collections._heapq.itemgetter.__delattr__
  • modo.util.collections._heapq.itemgetter.__doc__
  • modo.util.collections._heapq.itemgetter.__format__
  • modo.util.collections._heapq.itemgetter.__getattribute__
  • modo.util.collections._heapq.itemgetter.__hash__
  • modo.util.collections._heapq.itemgetter.__init__
  • modo.util.collections._heapq.itemgetter.__new__
  • modo.util.collections._heapq.itemgetter.__reduce__
  • modo.util.collections._heapq.itemgetter.__reduce_ex__
  • modo.util.collections._heapq.itemgetter.__repr__
  • modo.util.collections._heapq.itemgetter.__setattr__
  • modo.util.collections._heapq.itemgetter.__sizeof__
  • modo.util.collections._heapq.itemgetter.__str__
  • modo.util.collections._heapq.itemgetter.__subclasshook__
modo.util.collections._heapq.izip

type: type

doc: izip(iter1 [,iter2 [...]]) --> izip object Return a izip object whose .next() method returns a tuple where the i-th element comes from the i-th iterable argument. The .next() method continues until the shortest iterable in the argument sequence is exhausted and then it raises StopIteration. Works like the zip() function but consumes less memory by returning an iterator instead of a list.

    modo.util.collections._heapq.izip contents:
  • modo.util.collections._heapq.izip.__class__
  • modo.util.collections._heapq.izip.__delattr__
  • modo.util.collections._heapq.izip.__doc__
  • modo.util.collections._heapq.izip.__format__
  • modo.util.collections._heapq.izip.__getattribute__
  • modo.util.collections._heapq.izip.__hash__
  • modo.util.collections._heapq.izip.__init__
  • modo.util.collections._heapq.izip.__iter__
  • modo.util.collections._heapq.izip.__new__
  • modo.util.collections._heapq.izip.__reduce__
  • modo.util.collections._heapq.izip.__reduce_ex__
  • modo.util.collections._heapq.izip.__repr__
  • modo.util.collections._heapq.izip.__setattr__
  • modo.util.collections._heapq.izip.__sizeof__
  • modo.util.collections._heapq.izip.__str__
  • modo.util.collections._heapq.izip.__subclasshook__
  • modo.util.collections._heapq.izip.next

modo.util.collections._heapq.izip.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.util.collections._heapq.merge

type: function

doc: Merge multiple sorted inputs into a single sorted output. Similar to sorted(itertools.chain(*iterables)) but returns a generator, does not pull the data into memory all at once, and assumes that each of the input streams is already sorted (smallest to largest). >>> list(merge([1,3,5,7], [0,2,4,8], [5,10,15,20], [], [25])) [0, 1, 2, 3, 4, 5, 5, 7, 8, 10, 15, 20, 25]

file: .\Lib\heapq.py

modo.util.collections._heapq.nlargest

type: function

doc: Find the n largest elements in a dataset. Equivalent to: sorted(iterable, key=key, reverse=True)[:n]

file: .\Lib\heapq.py

modo.util.collections._heapq.nsmallest

type: function

doc: Find the n smallest elements in a dataset. Equivalent to: sorted(iterable, key=key)[:n]

file: .\Lib\heapq.py

modo.util.collections._heapq.repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.util.collections._heapq.repeat contents:
  • modo.util.collections._heapq.repeat.__class__
  • modo.util.collections._heapq.repeat.__delattr__
  • modo.util.collections._heapq.repeat.__doc__
  • modo.util.collections._heapq.repeat.__format__
  • modo.util.collections._heapq.repeat.__getattribute__
  • modo.util.collections._heapq.repeat.__hash__
  • modo.util.collections._heapq.repeat.__init__
  • modo.util.collections._heapq.repeat.__iter__
  • modo.util.collections._heapq.repeat.__length_hint__
  • modo.util.collections._heapq.repeat.__new__
  • modo.util.collections._heapq.repeat.__reduce__
  • modo.util.collections._heapq.repeat.__reduce_ex__
  • modo.util.collections._heapq.repeat.__repr__
  • modo.util.collections._heapq.repeat.__setattr__
  • modo.util.collections._heapq.repeat.__sizeof__
  • modo.util.collections._heapq.repeat.__str__
  • modo.util.collections._heapq.repeat.__subclasshook__
  • modo.util.collections._heapq.repeat.next

modo.util.collections._heapq.repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.util.collections._heapq.tee()

type: builtin_function_or_method

doc: tee(iterable, n=2) --> tuple of n independent iterators.

modo.util.collections._iskeyword()

type: builtin_function_or_method

doc: x.__contains__(y) <==> y in x.

modo.util.collections._itemgetter

type: type

doc: itemgetter(item, ...) --> itemgetter object Return a callable object that fetches the given item(s) from its operand. After, f=itemgetter(2), the call f(r) returns r[2]. After, g=itemgetter(2,5,3), the call g(r) returns (r[2], r[5], r[3])

    modo.util.collections._itemgetter contents:
  • modo.util.collections._itemgetter.__call__
  • modo.util.collections._itemgetter.__class__
  • modo.util.collections._itemgetter.__delattr__
  • modo.util.collections._itemgetter.__doc__
  • modo.util.collections._itemgetter.__format__
  • modo.util.collections._itemgetter.__getattribute__
  • modo.util.collections._itemgetter.__hash__
  • modo.util.collections._itemgetter.__init__
  • modo.util.collections._itemgetter.__new__
  • modo.util.collections._itemgetter.__reduce__
  • modo.util.collections._itemgetter.__reduce_ex__
  • modo.util.collections._itemgetter.__repr__
  • modo.util.collections._itemgetter.__setattr__
  • modo.util.collections._itemgetter.__sizeof__
  • modo.util.collections._itemgetter.__str__
  • modo.util.collections._itemgetter.__subclasshook__
modo.util.collections._repeat

type: type

doc: repeat(object [,times]) -> create an iterator which returns the object for the specified number of times. If not specified, returns the object endlessly.

    modo.util.collections._repeat contents:
  • modo.util.collections._repeat.__class__
  • modo.util.collections._repeat.__delattr__
  • modo.util.collections._repeat.__doc__
  • modo.util.collections._repeat.__format__
  • modo.util.collections._repeat.__getattribute__
  • modo.util.collections._repeat.__hash__
  • modo.util.collections._repeat.__init__
  • modo.util.collections._repeat.__iter__
  • modo.util.collections._repeat.__length_hint__
  • modo.util.collections._repeat.__new__
  • modo.util.collections._repeat.__reduce__
  • modo.util.collections._repeat.__reduce_ex__
  • modo.util.collections._repeat.__repr__
  • modo.util.collections._repeat.__setattr__
  • modo.util.collections._repeat.__sizeof__
  • modo.util.collections._repeat.__str__
  • modo.util.collections._repeat.__subclasshook__
  • modo.util.collections._repeat.next

modo.util.collections._repeat.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.util.collections._starmap

type: type

doc: starmap(function, sequence) --> starmap object Return an iterator whose values are returned from the function evaluated with a argument tuple taken from the given sequence.

    modo.util.collections._starmap contents:
  • modo.util.collections._starmap.__class__
  • modo.util.collections._starmap.__delattr__
  • modo.util.collections._starmap.__doc__
  • modo.util.collections._starmap.__format__
  • modo.util.collections._starmap.__getattribute__
  • modo.util.collections._starmap.__hash__
  • modo.util.collections._starmap.__init__
  • modo.util.collections._starmap.__iter__
  • modo.util.collections._starmap.__new__
  • modo.util.collections._starmap.__reduce__
  • modo.util.collections._starmap.__reduce_ex__
  • modo.util.collections._starmap.__repr__
  • modo.util.collections._starmap.__setattr__
  • modo.util.collections._starmap.__sizeof__
  • modo.util.collections._starmap.__str__
  • modo.util.collections._starmap.__subclasshook__
  • modo.util.collections._starmap.next

modo.util.collections._starmap.next

type: wrapper_descriptor

doc: x.next() -> the next value, or raise StopIteration

modo.util.collections._sys

type: module

doc: This module provides access to some objects used or maintained by the interpreter and to functions that interact strongly with the interpreter. Dynamic objects: argv -- command line arguments; argv[0] is the script pathname if known path -- module search path; path[0] is the script directory, else '' modules -- dictionary of loaded modules displayhook -- called to show results in an interactive session excepthook -- called to handle any uncaught exception other than SystemExit To customize printing in an interactive session or to install a custom top-level exception handler, assign other functions to replace these. exitfunc -- if sys.exitfunc exists, this routine is called when Python exits Assigning to sys.exitfunc is deprecated; use the atexit module instead. stdin -- standard input file object; used by raw_input() and input() stdout -- standard output file object; used by the print statement stderr -- standard error object; used for error messages By assigning other file objects (or objects that behave like files) to these, it is possible to redirect all of the interpreter's I/O. last_type -- type of last uncaught exception last_value -- value of last uncaught exception last_traceback -- traceback of last uncaught exception These three are only available in an interactive session after a traceback has been printed. exc_type -- type of exception currently being handled exc_value -- value of exception currently being handled exc_traceback -- traceback of exception currently being handled The function exc_info() should be used instead of these three, because it is thread-safe. Static objects: float_info -- a dict with information about the float inplementation. long_info -- a struct sequence with information about the long implementation. maxint -- the largest supported integer (the smallest is -maxint-1) maxsize -- the largest supported length of containers. maxunicode -- the largest supported character builtin_module_names -- tuple of module names built into this interpreter version -- the version of this interpreter as a string version_info -- version information as a named tuple hexversion -- version information encoded as a single integer copyright -- copyright notice pertaining to this interpreter platform -- platform identifier executable -- absolute path of the executable binary of the Python interpreter prefix -- prefix used to find the Python library exec_prefix -- prefix used to find the machine-specific Python library float_repr_style -- string indicating the style of repr() output for floats dllhandle -- [Windows only] integer handle of the Python DLL winver -- [Windows only] version number of the Python DLL __stdin__ -- the original stdin; don't touch! __stdout__ -- the original stdout; don't touch! __stderr__ -- the original stderr; don't touch! __displayhook__ -- the original displayhook; don't touch! __excepthook__ -- the original excepthook; don't touch! Functions: displayhook() -- print an object to the screen, and save it in __builtin__._ excepthook() -- print an exception and its traceback to sys.stderr exc_info() -- return thread-safe information about the current exception exc_clear() -- clear the exception state for the current thread exit() -- exit the interpreter by raising SystemExit getdlopenflags() -- returns flags to be used for dlopen() calls getprofile() -- get the global profiling function getrefcount() -- return the reference count for an object (plus one :-) getrecursionlimit() -- return the max recursion depth for the interpreter getsizeof() -- return the size of an object in bytes gettrace() -- get the global debug tracing function setcheckinterval() -- control how often the interpreter checks for events setdlopenflags() -- set the flags to be used for dlopen() calls setprofile() -- set the global profiling function setrecursionlimit() -- set the max recursion depth for the interpreter settrace() -- set the global debug tracing function

modo.util.collections._sys._clear_type_cache()

type: builtin_function_or_method

doc: _clear_type_cache() -> None Clear the internal type lookup cache.

modo.util.collections._sys._current_frames()

type: builtin_function_or_method

doc: _current_frames() -> dictionary Return a dictionary mapping each current thread T's thread id to T's current stack frame. This function should be used for specialized purposes only.

modo.util.collections._sys._getframe()

type: builtin_function_or_method

doc: _getframe([depth]) -> frameobject Return a frame object from the call stack. If optional integer depth is given, return the frame object that many calls below the top of the stack. If that is deeper than the call stack, ValueError is raised. The default for depth is zero, returning the frame at the top of the call stack. This function should be used for internal and specialized purposes only.

modo.util.collections._sys._mercurial

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.util.collections._sys.api_version

type: int

modo.util.collections._sys.builtin_module_names

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.util.collections._sys.byteorder

type: str

modo.util.collections._sys.call_tracing()

type: builtin_function_or_method

doc: call_tracing(func, args) -> object Call func(*args), while tracing is enabled. The tracing state is saved, and restored afterwards. This is intended to be called from a debugger from a checkpoint, to recursively debug some other code.

modo.util.collections._sys.callstats()

type: builtin_function_or_method

doc: callstats() -> tuple of integers Return a tuple of function call statistics, if CALL_PROFILE was defined when Python was built. Otherwise, return None. When enabled, this function returns detailed, implementation-specific details about the number of function calls executed. The return value is a 11-tuple where the entries in the tuple are counts of: 0. all function calls 1. calls to PyFunction_Type objects 2. PyFunction calls that do not create an argument tuple 3. PyFunction calls that do not create an argument tuple and bypass PyEval_EvalCodeEx() 4. PyMethod calls 5. PyMethod calls on bound methods 6. PyType calls 7. PyCFunction calls 8. generator calls 9. All other calls 10. Number of stack pops performed by call_function()

modo.util.collections._sys.copyright

type: str

modo.util.collections._sys.displayhook()

type: builtin_function_or_method

doc: displayhook(object) -> None Print an object to sys.stdout and also save it in __builtin__._

modo.util.collections._sys.dllhandle

type: long

modo.util.collections._sys.dont_write_bytecode

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.util.collections._sys.exc_clear()

type: builtin_function_or_method

doc: exc_clear() -> None Clear global information on the current exception. Subsequent calls to exc_info() will return (None,None,None) until another exception is raised in the current thread or the execution stack returns to a frame where another exception is being handled.

modo.util.collections._sys.exc_info()

type: builtin_function_or_method

doc: exc_info() -> (type, value, traceback) Return information about the most recent exception caught by an except clause in the current stack frame or in an older stack frame.

modo.util.collections._sys.exc_traceback

type: traceback

file: G:\Box Sync\Adam_WIP\MechanicalColor\KOMODO\kit\KOMODO\komodo\apidump\__init__.py

modo.util.collections._sys.exc_type

type: type

doc: Inappropriate argument type.

    modo.util.collections._sys.exc_type contents:
  • modo.util.collections._sys.exc_type.__class__
  • modo.util.collections._sys.exc_type.__delattr__
  • modo.util.collections._sys.exc_type.__dict__
  • modo.util.collections._sys.exc_type.__doc__
  • modo.util.collections._sys.exc_type.__format__
  • modo.util.collections._sys.exc_type.__getattribute__
  • modo.util.collections._sys.exc_type.__getitem__
  • modo.util.collections._sys.exc_type.__getslice__
  • modo.util.collections._sys.exc_type.__hash__
  • modo.util.collections._sys.exc_type.__init__
  • modo.util.collections._sys.exc_type.__new__
  • modo.util.collections._sys.exc_type.__reduce__
  • modo.util.collections._sys.exc_type.__reduce_ex__
  • modo.util.collections._sys.exc_type.__repr__
  • modo.util.collections._sys.exc_type.__setattr__
  • modo.util.collections._sys.exc_type.__setstate__
  • modo.util.collections._sys.exc_type.__sizeof__
  • modo.util.collections._sys.exc_type.__str__
  • modo.util.collections._sys.exc_type.__subclasshook__
  • modo.util.collections._sys.exc_type.__unicode__
  • modo.util.collections._sys.exc_type.args
  • modo.util.collections._sys.exc_type.message

modo.util.collections._sys.exc_type.args

type: getset_descriptor

modo.util.collections._sys.exc_type.message

type: getset_descriptor

modo.util.collections._sys.exc_value

type: TypeError

doc: Inappropriate argument type.

modo.util.collections._sys.excepthook()

type: builtin_function_or_method

doc: excepthook(exctype, value, traceback) -> None Handle an exception by displaying it with a traceback on sys.stderr.

modo.util.collections._sys.exec_prefix

type: str

modo.util.collections._sys.executable

type: str

modo.util.collections._sys.exit()

type: builtin_function_or_method

doc: exit([status]) Exit the interpreter by raising SystemExit(status). If the status is omitted or None, it defaults to zero (i.e., success). If the status is numeric, it will be used as the system exit status. If it is another kind of object, it will be printed and the system exit status will be one (i.e., failure).

modo.util.collections._sys.exitfunc

type: function

doc: run any registered exit functions _exithandlers is traversed in reverse order so functions are executed last in, first out.

file: .\Lib\atexit.py

modo.util.collections._sys.flags

type: flags

doc: sys.flags Flags provided through command line arguments or environment vars.

modo.util.collections._sys.float_info

type: float_info

doc: sys.float_info A structseq holding information about the float type. It contains low level information about the precision and internal representation. Please study your system's :file:`float.h` for more information.

modo.util.collections._sys.float_repr_style

type: str

modo.util.collections._sys.getcheckinterval()

type: builtin_function_or_method

doc: getcheckinterval() -> current check interval; see setcheckinterval().

modo.util.collections._sys.getdefaultencoding()

type: builtin_function_or_method

doc: getdefaultencoding() -> string Return the current default string encoding used by the Unicode implementation.

modo.util.collections._sys.getfilesystemencoding()

type: builtin_function_or_method

doc: getfilesystemencoding() -> string Return the encoding used to convert Unicode filenames in operating system filenames.

modo.util.collections._sys.getprofile()

type: builtin_function_or_method

doc: getprofile() Return the profiling function set with sys.setprofile. See the profiler chapter in the library manual.

modo.util.collections._sys.getrecursionlimit()

type: builtin_function_or_method

doc: getrecursionlimit() Return the current value of the recursion limit, the maximum depth of the Python interpreter stack. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python.

modo.util.collections._sys.getrefcount()

type: builtin_function_or_method

doc: getrefcount(object) -> integer Return the reference count of object. The count returned is generally one higher than you might expect, because it includes the (temporary) reference as an argument to getrefcount().

modo.util.collections._sys.getsizeof()

type: builtin_function_or_method

doc: getsizeof(object, default) -> int Return the size of object in bytes.

modo.util.collections._sys.gettrace()

type: builtin_function_or_method

doc: gettrace() Return the global debug tracing function set with sys.settrace. See the debugger chapter in the library manual.

modo.util.collections._sys.getwindowsversion()

type: builtin_function_or_method

doc: getwindowsversion() Return information about the running version of Windows as a named tuple. The members are named: major, minor, build, platform, service_pack, service_pack_major, service_pack_minor, suite_mask, and product_type. For backward compatibility, only the first 5 items are available by indexing. All elements are numbers, except service_pack which is a string. Platform may be 0 for win32s, 1 for Windows 9x/ME, 2 for Windows NT/2000/XP/Vista/7, 3 for Windows CE. Product_type may be 1 for a workstation, 2 for a domain controller, 3 for a server.

modo.util.collections._sys.hexversion

type: int

modo.util.collections._sys.long_info

type: long_info

doc: sys.long_info A struct sequence that holds information about Python's internal representation of integers. The attributes are read only.

modo.util.collections._sys.maxint

type: int

modo.util.collections._sys.maxsize

type: long

modo.util.collections._sys.maxunicode

type: int

modo.util.collections._sys.meta_path

type: list
modo.util.collections._sys.modules type: dict

modo.util.collections._sys.modules.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.util.collections._sys.modules.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.util.collections._sys.modules.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.util.collections._sys.modules.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.util.collections._sys.modules.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.util.collections._sys.modules.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.util.collections._sys.modules.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.util.collections._sys.modules.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.util.collections._sys.modules.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.util.collections._sys.modules.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.util.collections._sys.modules.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.util.collections._sys.modules.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.util.collections._sys.modules.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.util.collections._sys.modules.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.util.collections._sys.modules.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.util.collections._sys.modules.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.util.collections._sys.modules.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.util.collections._sys.modules.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.util.collections._sys.path

type: list

modo.util.collections._sys.path_hooks

type: list
modo.util.collections._sys.path_importer_cache type: dict

modo.util.collections._sys.path_importer_cache.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.util.collections._sys.path_importer_cache.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.util.collections._sys.path_importer_cache.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.util.collections._sys.path_importer_cache.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.util.collections._sys.path_importer_cache.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.util.collections._sys.path_importer_cache.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.util.collections._sys.path_importer_cache.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.util.collections._sys.path_importer_cache.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.util.collections._sys.path_importer_cache.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.util.collections._sys.path_importer_cache.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.util.collections._sys.path_importer_cache.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.util.collections._sys.path_importer_cache.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.util.collections._sys.path_importer_cache.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.util.collections._sys.path_importer_cache.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.util.collections._sys.path_importer_cache.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.util.collections._sys.path_importer_cache.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.util.collections._sys.path_importer_cache.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.util.collections._sys.path_importer_cache.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.util.collections._sys.platform

type: str

modo.util.collections._sys.prefix

type: str

modo.util.collections._sys.py3kwarning

type: bool

doc: bool(x) -> bool Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

modo.util.collections._sys.setcheckinterval()

type: builtin_function_or_method

doc: setcheckinterval(n) Tell the Python interpreter to check for asynchronous events every n instructions. This also affects how often thread switches occur.

modo.util.collections._sys.setprofile()

type: builtin_function_or_method

doc: setprofile(function) Set the profiling function. It will be called on each function call and return. See the profiler chapter in the library manual.

modo.util.collections._sys.setrecursionlimit()

type: builtin_function_or_method

doc: setrecursionlimit(n) Set the maximum depth of the Python interpreter stack to n. This limit prevents infinite recursion from causing an overflow of the C stack and crashing Python. The highest possible limit is platform- dependent.

modo.util.collections._sys.settrace()

type: builtin_function_or_method

doc: settrace(function) Set the global debug tracing function. It will be called on each function call. See the debugger chapter in the library manual.

modo.util.collections._sys.stderr

type: SESysStdErr

modo.util.collections._sys.stdin

type: SESysStdIn

modo.util.collections._sys.stdout

type: SESysStdOut

modo.util.collections._sys.subversion

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.util.collections._sys.version

type: str

modo.util.collections._sys.version_info

type: version_info

doc: sys.version_info Version information as a named tuple.

modo.util.collections._sys.warnoptions

type: list

modo.util.collections._sys.winver

type: str

modo.util.collections.Callable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.Container

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.Counter

type: type

doc: Dict subclass for counting hashable items. Sometimes called a bag or multiset. Elements are stored as dictionary keys and their counts are stored as dictionary values. >>> c = Counter('abcdeabcdabcaba') # count elements from a string >>> c.most_common(3) # three most common elements [('a', 5), ('b', 4), ('c', 3)] >>> sorted(c) # list all unique elements ['a', 'b', 'c', 'd', 'e'] >>> ''.join(sorted(c.elements())) # list elements with repetitions 'aaaaabbbbcccdde' >>> sum(c.values()) # total of all counts 15 >>> c['a'] # count of letter 'a' 5 >>> for elem in 'shazam': # update counts from an iterable ... c[elem] += 1 # by adding 1 to each element's count >>> c['a'] # now there are seven 'a' 7 >>> del c['b'] # remove all 'b' >>> c['b'] # now there are zero 'b' 0 >>> d = Counter('simsalabim') # make another counter >>> c.update(d) # add in the second counter >>> c['a'] # now there are nine 'a' 9 >>> c.clear() # empty the counter >>> c Counter() Note: If a count is set to zero or reduced to zero, it will remain in the counter until the entry is deleted or the counter is cleared: >>> c = Counter('aaabbc') >>> c['b'] -= 2 # reduce the count of 'b' by two >>> c.most_common() # 'b' is still in, but its count is zero [('a', 3), ('c', 1), ('b', 0)]

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.util.collections.Counter.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.util.collections.Counter.copy(self)

type: instancemethod

doc: Return a shallow copy.

file: .\Lib\collections.py

modo.util.collections.Counter.elements(self)

type: instancemethod

doc: Iterator over elements repeating each as many times as its count. >>> c = Counter('ABCABC') >>> sorted(c.elements()) ['A', 'A', 'B', 'B', 'C', 'C'] # Knuth's example for prime factors of 1836: 2**2 * 3**3 * 17**1 >>> prime_factors = Counter({2: 2, 3: 3, 17: 1}) >>> product = 1 >>> for factor in prime_factors.elements(): # loop over factors ... product *= factor # and multiply them >>> product 1836 Note, if an element's count has been set to zero or is a negative number, elements() will ignore it.

file: .\Lib\collections.py

modo.util.collections.Counter.fromkeys(cls,iterable,v)

type: instancemethod

file: .\Lib\collections.py

modo.util.collections.Counter.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.util.collections.Counter.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.util.collections.Counter.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.util.collections.Counter.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.util.collections.Counter.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.util.collections.Counter.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.util.collections.Counter.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.util.collections.Counter.most_common(self,n)

type: instancemethod

doc: List the n most common elements and their counts from the most common to the least. If n is None, then list all element counts. >>> Counter('abcdeabcdabcaba').most_common(3) [('a', 5), ('b', 4), ('c', 3)]

file: .\Lib\collections.py

modo.util.collections.Counter.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.util.collections.Counter.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.util.collections.Counter.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.util.collections.Counter.subtract(self,iterable)

type: instancemethod

doc: Like dict.update() but subtracts counts instead of replacing them. Counts can be reduced below zero. Both the inputs and outputs are allowed to contain zero and negative counts. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.subtract('witch') # subtract elements from another iterable >>> c.subtract(Counter('watch')) # subtract elements from another counter >>> c['h'] # 2 in which, minus 1 in witch, minus 1 in watch 0 >>> c['w'] # 1 in which, minus 1 in witch, minus 1 in watch -1

file: .\Lib\collections.py

modo.util.collections.Counter.update(self,iterable)

type: instancemethod

doc: Like dict.update() but add counts instead of replacing them. Source can be an iterable, a dictionary, or another Counter instance. >>> c = Counter('which') >>> c.update('witch') # add elements from another iterable >>> d = Counter('watch') >>> c.update(d) # add elements from another counter >>> c['h'] # four 'h' in which, witch, and watch 4

file: .\Lib\collections.py

modo.util.collections.Counter.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.util.collections.Counter.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.util.collections.Counter.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.util.collections.Counter.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.util.collections.defaultdict

type: type

doc: defaultdict(default_factory) --> dict with default factory The default factory is called without arguments to produce a new value when a key is not present, in __getitem__ only. A defaultdict compares equal to a dict with the same items.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.util.collections.defaultdict.clear()

type: method_descriptor

doc: D.clear() -> None. Remove all items from D.

modo.util.collections.defaultdict.copy()

type: method_descriptor

doc: D.copy() -> a shallow copy of D.

modo.util.collections.defaultdict.default_factory

type: member_descriptor

doc: Factory for default value called by __missing__().

modo.util.collections.defaultdict.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.util.collections.defaultdict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.util.collections.defaultdict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.util.collections.defaultdict.items()

type: method_descriptor

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.util.collections.defaultdict.iteritems()

type: method_descriptor

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.util.collections.defaultdict.iterkeys()

type: method_descriptor

doc: D.iterkeys() -> an iterator over the keys of D

modo.util.collections.defaultdict.itervalues()

type: method_descriptor

doc: D.itervalues() -> an iterator over the values of D

modo.util.collections.defaultdict.keys()

type: method_descriptor

doc: D.keys() -> list of D's keys

modo.util.collections.defaultdict.pop()

type: method_descriptor

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.util.collections.defaultdict.popitem()

type: method_descriptor

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.util.collections.defaultdict.setdefault()

type: method_descriptor

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.util.collections.defaultdict.update()

type: method_descriptor

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.util.collections.defaultdict.values()

type: method_descriptor

doc: D.values() -> list of D's values

modo.util.collections.defaultdict.viewitems()

type: method_descriptor

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.util.collections.defaultdict.viewkeys()

type: method_descriptor

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.util.collections.defaultdict.viewvalues()

type: method_descriptor

doc: D.viewvalues() -> an object providing a view on D's values

modo.util.collections.deque

type: type

doc: deque(iterable[, maxlen]) --> deque object Build an ordered collection with optimized access from its endpoints.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.util.collections.deque.append()

type: method_descriptor

doc: Add an element to the right side of the deque.

modo.util.collections.deque.appendleft()

type: method_descriptor

doc: Add an element to the left side of the deque.

modo.util.collections.deque.clear()

type: method_descriptor

doc: Remove all elements from the deque.

modo.util.collections.deque.count()

type: method_descriptor

doc: D.count(value) -> integer -- return number of occurrences of value

modo.util.collections.deque.extend()

type: method_descriptor

doc: Extend the right side of the deque with elements from the iterable

modo.util.collections.deque.extendleft()

type: method_descriptor

doc: Extend the left side of the deque with elements from the iterable

modo.util.collections.deque.maxlen

type: getset_descriptor

doc: maximum size of a deque or None if unbounded

modo.util.collections.deque.pop()

type: method_descriptor

doc: Remove and return the rightmost element.

modo.util.collections.deque.popleft()

type: method_descriptor

doc: Remove and return the leftmost element.

modo.util.collections.deque.remove()

type: method_descriptor

doc: D.remove(value) -- remove first occurrence of value.

modo.util.collections.deque.reverse()

type: method_descriptor

doc: D.reverse() -- reverse *IN PLACE*

modo.util.collections.deque.rotate()

type: method_descriptor

doc: Rotate the deque n steps to the right (default n=1). If n is negative, rotates left.

modo.util.collections.Hashable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.ItemsView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.Iterator

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.KeysView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.Mapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.MappingView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.MutableMapping

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.MutableSequence

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.MutableSet

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.namedtuple

type: function

doc: Returns a new subclass of tuple with named fields. >>> Point = namedtuple('Point', 'x y') >>> Point.__doc__ # docstring for the new class 'Point(x, y)' >>> p = Point(11, y=22) # instantiate with positional args or keywords >>> p[0] + p[1] # indexable like a plain tuple 33 >>> x, y = p # unpack like a regular tuple >>> x, y (11, 22) >>> p.x + p.y # fields also accessable by name 33 >>> d = p._asdict() # convert to a dictionary >>> d['x'] 11 >>> Point(**d) # convert from a dictionary Point(x=11, y=22) >>> p._replace(x=100) # _replace() is like str.replace() but targets named fields Point(x=100, y=22)

file: .\Lib\collections.py

modo.util.collections.OrderedDict

type: type

doc: Dictionary that remembers insertion order

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\collections.pyc

modo.util.collections.OrderedDict._OrderedDict__marker

type: object

doc: The most base type

modo.util.collections.OrderedDict._OrderedDict__update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.util.collections.OrderedDict.clear(self)

type: instancemethod

doc: od.clear() -> None. Remove all items from od.

file: .\Lib\collections.py

modo.util.collections.OrderedDict.copy(self)

type: instancemethod

doc: od.copy() -> a shallow copy of od

file: .\Lib\collections.py

modo.util.collections.OrderedDict.fromkeys(cls,iterable,value)

type: instancemethod

doc: OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S. If not specified, the value defaults to None.

file: .\Lib\collections.py

modo.util.collections.OrderedDict.get()

type: method_descriptor

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.util.collections.OrderedDict.has_key()

type: method_descriptor

doc: D.has_key(k) -> True if D has a key k, else False

modo.util.collections.OrderedDict.items(self)

type: instancemethod

doc: od.items() -> list of (key, value) pairs in od

file: .\Lib\collections.py

modo.util.collections.OrderedDict.iteritems(self)

type: instancemethod

doc: od.iteritems -> an iterator over the (key, value) pairs in od

file: .\Lib\collections.py

modo.util.collections.OrderedDict.iterkeys(self)

type: instancemethod

doc: od.iterkeys() -> an iterator over the keys in od

file: .\Lib\collections.py

modo.util.collections.OrderedDict.itervalues(self)

type: instancemethod

doc: od.itervalues -> an iterator over the values in od

file: .\Lib\collections.py

modo.util.collections.OrderedDict.keys(self)

type: instancemethod

doc: od.keys() -> list of keys in od

file: .\Lib\collections.py

modo.util.collections.OrderedDict.pop(self,key,default)

type: instancemethod

doc: od.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

file: .\Lib\collections.py

modo.util.collections.OrderedDict.popitem(self,last)

type: instancemethod

doc: od.popitem() -> (k, v), return and remove a (key, value) pair. Pairs are returned in LIFO order if last is true or FIFO order if false.

file: .\Lib\collections.py

modo.util.collections.OrderedDict.setdefault(self,key,default)

type: instancemethod

doc: od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od

file: .\Lib\collections.py

modo.util.collections.OrderedDict.update()

type: instancemethod

file: u:\Luxology\source\extra\python\python2.7\lib\_abcoll.py

modo.util.collections.OrderedDict.values(self)

type: instancemethod

doc: od.values() -> list of values in od

file: .\Lib\collections.py

modo.util.collections.OrderedDict.viewitems(self)

type: instancemethod

doc: od.viewitems() -> a set-like object providing a view on od's items

file: .\Lib\collections.py

modo.util.collections.OrderedDict.viewkeys(self)

type: instancemethod

doc: od.viewkeys() -> a set-like object providing a view on od's keys

file: .\Lib\collections.py

modo.util.collections.OrderedDict.viewvalues(self)

type: instancemethod

doc: od.viewvalues() -> an object providing a view on od's values

file: .\Lib\collections.py

modo.util.collections.Sequence

type: ABCMeta

doc: All the operations on a read-only sequence. Concrete subclasses must override __new__ or __init__, __getitem__, and __len__.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.Set

type: ABCMeta

doc: A set is a finite, iterable container. This class provides concrete generic implementations of all methods except for __contains__, __iter__ and __len__. To override the comparisons (presumably for speed, as the semantics are fixed), all you have to do is redefine __le__ and then the other operations will automatically follow suit.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.Sized

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.collections.ValuesView

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.ensureModoItem

type: function

doc: Decorator - ensures that the argument passed as the first parameter to a function is an instance of the modo :class:`Item` class. Should only only be used to decorate methods where the first argument is meant to be an item and ensures that if for any reason an item of either type lx.object.Item or lxu.object.Item gets passed to the method it will get wrapped as an modo.item.Item object before being used.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.util.floatEquals

type: function

doc: Test if two floats are equal :returns bool:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.util.functools

type: module

doc: functools.py - Tools for working with functions and callable objects

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

modo.util.functools.cmp_to_key

type: function

doc: Convert a cmp= function into a key= function

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.util.functools.partial

type: type

doc: partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\functools.pyc

    modo.util.functools.partial contents:
  • modo.util.functools.partial.__call__
  • modo.util.functools.partial.__class__
  • modo.util.functools.partial.__delattr__
  • modo.util.functools.partial.__dict__
  • modo.util.functools.partial.__doc__
  • modo.util.functools.partial.__format__
  • modo.util.functools.partial.__getattribute__
  • modo.util.functools.partial.__hash__
  • modo.util.functools.partial.__init__
  • modo.util.functools.partial.__new__
  • modo.util.functools.partial.__reduce__
  • modo.util.functools.partial.__reduce_ex__
  • modo.util.functools.partial.__repr__
  • modo.util.functools.partial.__setattr__
  • modo.util.functools.partial.__setstate__
  • modo.util.functools.partial.__sizeof__
  • modo.util.functools.partial.__str__
  • modo.util.functools.partial.__subclasshook__
  • modo.util.functools.partial.args
  • modo.util.functools.partial.func
  • modo.util.functools.partial.keywords

modo.util.functools.partial.args

type: member_descriptor

doc: tuple of arguments to future partial calls

modo.util.functools.partial.func

type: member_descriptor

doc: function object to use in future partial calls

modo.util.functools.partial.keywords

type: member_descriptor

doc: dictionary of keyword arguments to future partial calls

modo.util.functools.reduce()

type: builtin_function_or_method

doc: reduce(function, sequence[, initial]) -> value Apply a function of two arguments cumulatively to the items of a sequence, from left to right, so as to reduce the sequence to a single value. For example, reduce(lambda x, y: x+y, [1, 2, 3, 4, 5]) calculates ((((1+2)+3)+4)+5). If initial is present, it is placed before the items of the sequence in the calculation, and serves as a default when the sequence is empty.

modo.util.functools.total_ordering

type: function

doc: Class decorator that fills in missing ordering methods

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.util.functools.update_wrapper

type: function

doc: Update a wrapper function to look like the wrapped function wrapper is the function to be updated wrapped is the original function assigned is a tuple naming the attributes assigned directly from the wrapped function to the wrapper function (defaults to functools.WRAPPER_ASSIGNMENTS) updated is a tuple naming the attributes of the wrapper that are updated with the corresponding attribute from the wrapped function (defaults to functools.WRAPPER_UPDATES)

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.util.functools.WRAPPER_ASSIGNMENTS

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.util.functools.WRAPPER_UPDATES

type: tuple

doc: tuple() -> empty tuple tuple(iterable) -> tuple initialized from iterable's items If the argument is a tuple, the return value is the same object.

modo.util.functools.wraps

type: function

doc: Decorator factory to apply update_wrapper() to a wrapper function Returns a decorator that invokes update_wrapper() with the decorated function as the wrapper argument and the arguments to wraps() as the remaining arguments. Default arguments are as for update_wrapper(). This is a convenience function to simplify applying partial() to update_wrapper().

file: u:\Luxology\source\extra\python\python2.7\lib\functools.py

modo.util.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip

type: type

doc: Action Clip and Render pass item. :param item: either an item of type 'actionclip' or an item name/ID to lookup. :type item: an instance of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip._item

type: property

modo.util.item.ActionClip._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.active

type: property

doc: Set or get the active state of the render pass. :getter: Returns the active state of the render pass. :rtype: bool :setter: Sets the active state of the renter pass :param state: active state. :type state: bool

modo.util.item.ActionClip.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.ActionClip.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.ActionClip.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.ActionClip.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.ActionClip.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.enabled

type: property

doc: Get or set the enabled state of the render pass. :getter: Returns the enabled state. :rtype: bool :setter: Sets the enabled state of the render pass :param state: enabled state. :type state: bool

modo.util.item.ActionClip.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.getValue(self,chan,time)

type: instancemethod

doc: Read a value set on a channel for this render pass. :param chan: the channel to read the value from. :type chan: modo.channel.Channel object :param time: the time (in seconds) to read the value for, defaults to 0.0. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.ActionClip.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.ActionClip.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.ActionClip.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.ActionClip.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.ActionClip.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.ActionClip.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.name

type: property

doc: Name of the render pass. :getter: Returns the name of the render pass :rtype: basestring :setter: Assigns a new name to the render pass :param name: new name for the render pass. :type name: basestring

modo.util.item.ActionClip.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.ActionClip.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.ActionClip.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.ActionClip.passGroup

type: property

doc: The render pass group that the render pass belongs to. :getter: Returns the render pass group :rtype: modo.item.RenderPassGroup :setter: Sets the render pass group :param group: render pass group to parent to. :type group: modo.item.RenderPassGroup

modo.util.item.ActionClip.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.scene

type: property

modo.util.item.ActionClip.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.ActionClip.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.setValue(self,chan,value,time,key)

type: instancemethod

doc: Set a value on a channel for this render pass. :param chan: the channel to set the value on. :type chan: modo.channel.Channel object :param value: the value to set for the channel. :type value: any :param time: the time (in seconds) to set the value for, defaults to 0.0. :type time: float :param key: whether to set a key for the value or not, defaults to False. :param key: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ActionClip.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.ActionClip.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Actor

type: type

doc: Wrapper class for actor groups.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor._Actor__addClip(self,name,pose)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor._item

type: property

modo.util.item.Actor._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.actions

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.util.item.Actor.addAction(self,name)

type: instancemethod

doc: Adds an action to this actor Note: please avoid naming actions 'setup', 'edit' or 'scene' :returns ActionClip: ActionClip :param basestring name: Optional name for the action

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.addPose(self,name,activate)

type: instancemethod

doc: Adds a pose to this actor :returns ActionClip: ActionClip :param basestring name: Optional name for the pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.Actor.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.Actor.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.Actor.currentAction

type: property

doc: :getter: Returns the currently active action if any. None if no action is active :rtype: ActionClip

modo.util.item.Actor.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.Actor.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.util.item.Actor.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.util.item.Actor.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.Actor.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.Actor.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.Actor.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.Actor.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.util.item.Actor.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.Actor.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.Actor.items

type: property

doc: :getter: Returns a list of LocatorSuperType items that are connected to this action. :rtype: list

modo.util.item.Actor.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.Actor.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.Actor.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.Actor.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.Actor.pose(self,poseName)

type: instancemethod

doc: Return a pose by name :param basestring poseName: Name of the pose to look up :returns: Pose

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.poses

type: property

doc: :getter: Returns a list of ActionClip objects for this Actor :rtype: list

modo.util.item.Actor.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.scene

type: property

modo.util.item.Actor.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.Actor.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Actor.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Actor.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.util.item.AreaLight

type: type

doc: Area light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Area Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. :param light: Optional area light item object (type lx.symbol.sITYPE_AREALIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid area light item selected. :raises TypeError: if the item passed as an argument isn't either an area light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight._item

type: property

modo.util.item.AreaLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.AreaLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.AreaLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.AreaLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.AreaLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.AreaLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.AreaLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.AreaLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.AreaLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.AreaLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.AreaLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.util.item.AreaLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.AreaLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.AreaLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.AreaLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.AreaLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.AreaLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.AreaLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.AreaLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.AreaLight.scene

type: property

modo.util.item.AreaLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.AreaLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.AreaLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.AreaLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.AreaLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.util.item.Camera

type: type

doc: Camera item class. Takes an optional 'camera' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'camera' or an item name or ID to look up. If no camera item is supplied as an argument an attempt will be made to wrap the most recently selected camera. :param camera: Optional camera item object (type lx.symbol.sITYPE_CAMERA) or string (item name or ID) to look up. :type camera: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid camera item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'camera' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the camera argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera._item

type: property

modo.util.item.Camera._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.Camera.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.Camera.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.Camera.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.Camera.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.Camera.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.Camera.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.Camera.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.Camera.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.Camera.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.Camera.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.Camera.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.Camera.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.Camera.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.Camera.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Camera.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Camera.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Camera.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Camera.scene

type: property

modo.util.item.Camera.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.Camera.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Camera.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Camera.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.Camera.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Channel

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Add a link between this channel and another. :param to_channel: The channel to link to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Channel.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Delete a link from the channel graph. :param to_channel: The channel the link is to. :type to_channel: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Channel.disconnectInput(self,other)

type: instancemethod

doc: Removes an input connection from another channel if it exists. :param Channel other: Other channel to disconnect from. If it is None, all input connections are removed.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Channel.envelope

type: property

doc: Returns the channel's animation envelope. :getter: Returns the channel's animation envelope. :rtype: modo.channel.Envelope :raises LookupError: if the channel isn't animated.

modo.util.item.Channel.evalType

type: property

doc: Returns the evaluation type of a channel, which is the type of slot allocated in the eval state vector. This will return the "gradstack" exo-type for gradient channels. :getter: Returns the evaluation type of the channel :rtype: basestring

modo.util.item.Channel.forward(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index forward of this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index forward of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Channel.fwdCount

type: property

doc: Returns the number of linked channels forward of this channel in this channel graph. :getter: Returns the number of linked channels forward of this channel in this channel graph. :rtype: int

modo.util.item.Channel.fwdLinked

type: property

doc: Returns a list of the linked channels forward of this channel in the channel graph. :getter: Returns the forward channels in this item's channel graph. :rtype: list

modo.util.item.Channel.get(self,time,action)

type: instancemethod

doc: Returns a channel's value for an action at a specific time. Defaults to reading the channel's evaluated value at the current time. :param time: Optional time in seconds to read the value at. :type time: float :param action: The action to read the value from. Defaults to None (evaluation). :type action: basestring :returns: the channel's value. :rtype: depends on the type of the channel being read.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Channel.graph

type: property

doc: The channel's channel graph. :getter: Returns the channel's channel graph. :rtype: lxu.object.ChannelGraph

modo.util.item.Channel.index

type: property

doc: The channel's index. :getter: Returns the channel's index. :rtype: int

modo.util.item.Channel.isAnimated

type: property

doc: Returns whether the channel is animated. :getter: Returns whether the channel is animated or not. :rtype: bool

modo.util.item.Channel.item

type: property

doc: :getter: Returns the item that is associated with this channel :rtype: Item

modo.util.item.Channel.name

type: property

doc: The channel's name. :getter: Returns the channel's name. :rtype: basestring

modo.util.item.Channel.revCount

type: property

doc: Returns the number of linked channels that occur before this channel in the channel graph. :getter: Returns the number of linked channels that occur before this channel in the channel graph. :rtype: int

modo.util.item.Channel.reverse(self,index)

type: instancemethod

doc: Returns the linked channel at the specified index before this channel in the channel graph. :param index: The index of the channel to return. :type index: int :returns: The channel at specified index before of this channel. :rtype: modo.channel.Channel

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Channel.revLinked

type: property

doc: Returns a list of the linked channels that appear before this channel in the channel graph. :getter: Returns the linked channels that appear before this channel in the channel graph. :rtype: list

modo.util.item.Channel.set(self,value,time,key,action)

type: instancemethod

doc: Sets a channel's value for an action at a specific time. Defaults to setting the channel's value for the "edit" action and at the current time. :param value: The value to set for the channel. :type value: depends on the type of the channel :param time: optional time in seconds to set the value for. :type time: float :param key: Specifies whether to set a key for the channel. :type key: bool :param action: The action to set the value on. :type action: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

type: instancemethod

doc: Set a link's position (from index, to index) in the channel graph. :param from_index: The index in the channel graph for the current (from) channel. :type from_index: int :param to_channel: The to channel. :type to_channel: modo.channel.Channel :param to_index: the index in the channel graph for the 'to' channel. :type to_index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Channel.storageType

type: property

doc: Returns the storage type of the channel, which can be valid exo-type name for numeric and stored custom types or None if no storage type is found. :getter: Returns the channel storage type :rtype: basestring

modo.util.item.Channel.type

type: property

doc: Returns the channel type. The numeric and gradient types can be keyframed. The return type is an int which translates to the following types: | 0: none | 1: integer | 2: float | 3: gradient | 4: storage | 5: eval :getter: Returns the channel type. :rtype: int

modo.util.item.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.util.item.ChannelRead contents:
  • modo.util.item.ChannelRead.__class__
  • modo.util.item.ChannelRead.__delattr__
  • modo.util.item.ChannelRead.__dict__
  • modo.util.item.ChannelRead.__doc__
  • modo.util.item.ChannelRead.__format__
  • modo.util.item.ChannelRead.__getattr__
  • modo.util.item.ChannelRead.__getattribute__
  • modo.util.item.ChannelRead.__hash__
  • modo.util.item.ChannelRead.__init__
  • modo.util.item.ChannelRead.__module__
  • modo.util.item.ChannelRead.__new__
  • modo.util.item.ChannelRead.__reduce__
  • modo.util.item.ChannelRead.__reduce_ex__
  • modo.util.item.ChannelRead.__repr__
  • modo.util.item.ChannelRead.__setattr__
  • modo.util.item.ChannelRead.__sizeof__
  • modo.util.item.ChannelRead.__str__
  • modo.util.item.ChannelRead.__subclasshook__
  • modo.util.item.ChannelRead.__weakref__
  • modo.util.item.ChannelRead.set

modo.util.item.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.ChannelTriple

type: type

doc: Wrapper to allow setting and reading all three channels on a vector 'channel' at once :param basestring channelName: The channel name. eg 'diffCol' :param modo.item.Item item: The item the channel belongs to. :raises: LookUpError if no respective channel of the given name was found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.util.item.ChannelTriple contents:
  • modo.util.item.ChannelTriple.__class__
  • modo.util.item.ChannelTriple.__delattr__
  • modo.util.item.ChannelTriple.__dict__
  • modo.util.item.ChannelTriple.__doc__
  • modo.util.item.ChannelTriple.__format__
  • modo.util.item.ChannelTriple.__getattribute__
  • modo.util.item.ChannelTriple.__hash__
  • modo.util.item.ChannelTriple.__init__
  • modo.util.item.ChannelTriple.__module__
  • modo.util.item.ChannelTriple.__new__
  • modo.util.item.ChannelTriple.__reduce__
  • modo.util.item.ChannelTriple.__reduce_ex__
  • modo.util.item.ChannelTriple.__repr__
  • modo.util.item.ChannelTriple.__setattr__
  • modo.util.item.ChannelTriple.__sizeof__
  • modo.util.item.ChannelTriple.__str__
  • modo.util.item.ChannelTriple.__subclasshook__
  • modo.util.item.ChannelTriple.__weakref__
  • modo.util.item.ChannelTriple.get
  • modo.util.item.ChannelTriple.set

modo.util.item.ChannelTriple.get(self)

type: instancemethod

doc: Same arguments as Channel.get()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.ChannelTriple.set(self,values,time,action)

type: instancemethod

doc: Sets three values for the three channels at once :param float time: Time in seconds for the value to be set at (optional) :param basestring action: Action to set the value for (optional)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.util.item.ChannelWrite contents:
  • modo.util.item.ChannelWrite.__class__
  • modo.util.item.ChannelWrite.__delattr__
  • modo.util.item.ChannelWrite.__dict__
  • modo.util.item.ChannelWrite.__doc__
  • modo.util.item.ChannelWrite.__format__
  • modo.util.item.ChannelWrite.__getattr__
  • modo.util.item.ChannelWrite.__getattribute__
  • modo.util.item.ChannelWrite.__hash__
  • modo.util.item.ChannelWrite.__init__
  • modo.util.item.ChannelWrite.__module__
  • modo.util.item.ChannelWrite.__new__
  • modo.util.item.ChannelWrite.__reduce__
  • modo.util.item.ChannelWrite.__reduce_ex__
  • modo.util.item.ChannelWrite.__repr__
  • modo.util.item.ChannelWrite.__setattr__
  • modo.util.item.ChannelWrite.__sizeof__
  • modo.util.item.ChannelWrite.__str__
  • modo.util.item.ChannelWrite.__subclasshook__
  • modo.util.item.ChannelWrite.__weakref__
  • modo.util.item.ChannelWrite.set

modo.util.item.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.CylinderLight

type: type

doc: Cylinder light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Cylinder Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Cylinder Light item. :param light: Optional Cylinder light item object (type lx.symbol.sITYPE_CYLINDERLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid cylinder light item selected. :raises TypeError: if the item passed as an argument isn't either a cylinder light or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight._item

type: property

modo.util.item.CylinderLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.CylinderLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.CylinderLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.CylinderLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.CylinderLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.CylinderLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.CylinderLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.CylinderLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.CylinderLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.CylinderLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.CylinderLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.util.item.CylinderLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.CylinderLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.CylinderLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.CylinderLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.CylinderLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.CylinderLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.CylinderLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.CylinderLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.CylinderLight.scene

type: property

modo.util.item.CylinderLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.CylinderLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.CylinderLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.CylinderLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.CylinderLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Deformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer._item

type: property

modo.util.item.Deformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.Deformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.Deformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.Deformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.Deformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.Deformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.Deformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.Deformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.Deformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.Deformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.Deformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.util.item.Deformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.Deformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.util.item.Deformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.Deformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.Deformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.Deformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.scene

type: property

modo.util.item.Deformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.Deformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Deformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Deformer.svc

type: Deformer

modo.util.item.Deformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.DeformerGroup

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup._item

type: property

modo.util.item.DeformerGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.DeformerGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.DeformerGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.DeformerGroup.connectInput(self,other)

type: instancemethod

doc: Connects an influence deformer into this deformGroup :param other:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.createJointLocator(self,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.DeformerGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.DeformerGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.DeformerGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.DeformerGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.DeformerGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.DeformerGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.DeformerGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.mesh(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.DeformerGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.DeformerGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.DeformerGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.DeformerGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.scene

type: property

modo.util.item.DeformerGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.DeformerGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DeformerGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.DeformerGroup.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.DirectionalLight

type: type

doc: Directional light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Directional Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Directional Light item. :param light: Optional Directional light item object (type lx.symbol.sITYPE_SUNLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid directional light item selected. :raises TypeError: if the item passed as an argument isn't either a Directional light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight._item

type: property

modo.util.item.DirectionalLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.DirectionalLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.DirectionalLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.DirectionalLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.DirectionalLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.DirectionalLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.DirectionalLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.DirectionalLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.DirectionalLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.DirectionalLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.DirectionalLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.util.item.DirectionalLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.DirectionalLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.DirectionalLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.DirectionalLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.DirectionalLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.DirectionalLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.DirectionalLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.DirectionalLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.DirectionalLight.scene

type: property

modo.util.item.DirectionalLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.DirectionalLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DirectionalLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.DirectionalLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.DirectionalLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.DomeLight

type: type

doc: Dome light item class Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Dome Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Dome Light item. :param light: Optional Dome light item object (type lx.symbol.sITYPE_DOMELIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Dome light item selected. :raises TypeError: if the item passed as an argument isn't either a Dome light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight._item

type: property

modo.util.item.DomeLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.DomeLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.DomeLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.DomeLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.DomeLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.DomeLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.DomeLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.DomeLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.DomeLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.DomeLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.DomeLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.util.item.DomeLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.DomeLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.DomeLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.DomeLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.DomeLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.DomeLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.DomeLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.DomeLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.DomeLight.scene

type: property

modo.util.item.DomeLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.DomeLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.DomeLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.DomeLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.DomeLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Envelope

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Envelope.behavior

type: property

doc: gets/sets the behavior of times for both before the first keyframe and after the last keyframe in the envelope. :setter: Sets the envelope behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope behavior :rtype: int

modo.util.item.Envelope.clear(self)

type: instancemethod

doc: Clears (removes all keys from) the envelope.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Envelope.interpolation

type: property

doc: Returns the interpolation setting for the envelope. Can be one of: | lx.symbol.iENVv_INTERP_CURVE | lx.symbol.iENVv_INTERP_LINEAR | lx.symbol.iENVv_INTERP_STEPPED :getter: Returns the interpolation setting for the envelope. :rtype: int

modo.util.item.Envelope.isInt

type: property

doc: Returns whether the envelope is integer-valued type, if not it's a float type. :Getter: Returns True if the envelope is integer-valued type, False otherwise. :rtype: bool

modo.util.item.Envelope.keyframes

type: property

doc: Returns a :class:`Keyframes` object that provides access to the keyframes set for the envelope and methods to manipulate them. :getter: Returns a :class:`Keyframes` object containing the keys for this envelope. :rtype: modo.channel.Keyframes

modo.util.item.Envelope.postBehaviour

type: property

doc: gets/sets the behavior of times after the last keyframe in the envelope. :setter: Sets the envelope post behavior :param behavior: the behaviour to set for the envelope. See :meth:`preBehaviour` for available options. :type behavior: int :getter: Returns the envelope post behavior :rtype: int

modo.util.item.Envelope.preBehaviour

type: property

doc: gets/sets the behavior of times before the first keyframe in the envelope. - **RESET** A default value, or may be just zero. - **CONSTANT** The value of the first or last keyframe. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **REPEAT** The values in the keyframe range repeating continuously. - **OSCILLATE** Like repeat, but the values run forwards and backward alternately. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **OFFSETREPEAT** Like repeat, but the values are offset in each cycle by the difference between the first and last keyframes. For first or last keys set to "Auto" or "Auto Flat" the slopes of the keys will be adjusted to provide a smooth interpolation to or from the behavior. - **LINEAR** Linear interpolation from the slope at the nearest keyframe. - **NONE** Indicates that the envelope does not exist before or after the explicit keyframe range. This can be used by motion evaluation code to decide whether to use the envelope for a channel or to look up the parent envelope or default value. - **CONSTANT_KEEP_SLOPE** As for constant except that the slopes of the first or last keys are not changed. - **OSCILLATE_KEEP_SLOPE** As for oscillate except that the slopes of the first or last keys are not changed. - **OFFSETREPEAT_KEEP_SLOPE** As for offset repeat except that the slopes of the first or last keys are not changed. :setter: Sets the behavior :param behavior: the behaviour to set for the envelope. Can be one of: | lx.symbol.iENV_RESET | lx.symbol.iENV_CONSTANT | lx.symbol.iENV_REPEAT | lx.symbol.iENV_OSCILLATE | lx.symbol.iENV_OFFSETREPEAT | lx.symbol.iENV_LINEAR | lx.symbol.iENV_NONE | lx.symbol.iENV_CONSTANT_KEEP_SLOPE | lx.symbol.iENV_OSCILLATE_KEEP_SLOPE | lx.symbol.iENV_OFFSETREPEAT_KEEP_SLOPE :type behavior: int :getter: Returns envelope behavior :rtype: int

modo.util.item.Envelope.value(self,time)

type: instancemethod

doc: Returns the value of the envelope evaluated at the specified time. If no time is explicitly provided the value of the envelope at the current time is returned :param time: time to evaluate envelope at. :type time: float :returns: value of the envelope :rtype: float for float type envelopes, int for integer-valued type envelopes

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.util.item.GeneralInfluenceDeformer

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer._item

type: property

modo.util.item.GeneralInfluenceDeformer._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.GeneralInfluenceDeformer.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.GeneralInfluenceDeformer.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.GeneralInfluenceDeformer.connectInput(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.GeneralInfluenceDeformer.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.GeneralInfluenceDeformer.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.GeneralInfluenceDeformer.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.GeneralInfluenceDeformer.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.GeneralInfluenceDeformer.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.GeneralInfluenceDeformer.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.GeneralInfluenceDeformer.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.mapName

type: property

doc: :getter: Returns the UI version of the map name as string

modo.util.item.GeneralInfluenceDeformer.meshes

type: property

doc: :getter: Returns a list of connected meshes

modo.util.item.GeneralInfluenceDeformer.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.GeneralInfluenceDeformer.numMeshes

type: property

doc: :getter: Returns the number of meshes connected to this deformer

modo.util.item.GeneralInfluenceDeformer.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.GeneralInfluenceDeformer.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.GeneralInfluenceDeformer.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.GeneralInfluenceDeformer.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.scene

type: property

modo.util.item.GeneralInfluenceDeformer.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.GeneralInfluenceDeformer.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GeneralInfluenceDeformer.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.GeneralInfluenceDeformer.svc

type: Deformer

modo.util.item.GeneralInfluenceDeformer.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Group

type: type

doc: A group item. Takes an optional 'groupItem' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group' or an item name or ID to look up. If no groupItem is supplied as an argument an attempt will be made to wrap the most recently selected Area Light item. 'gtype' can be any one of the built in group types by passing one of the built in type strings ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader'), an empty string for a general group or any other string to create a custom group type. :param groupItem: an optional group item (type lx.symbol.sITYPE_GROUP) or an item name/ID to look up. :type groupItem: an instance of lx.object.Item, lxu.object.item or modo.item.Item :param gtype: the group type. :type gtype: basestring :raises TypeError: if an item is supplied as the groupItem argument but is not of type lx.symbol.sITYPE_GROUP. :raises ValueError: if no groupItem argument is supplied and no valid group item is selected in the scene. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found. Note that the children() method derived from the Item object will only list child groups. To iterate the contained items, use the method items.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group._item

type: property

modo.util.item.Group._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.Group.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.Group.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.Group.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.Group.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.util.item.Group.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.util.item.Group.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.Group.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.Group.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.Group.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.Group.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.util.item.Group.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.Group.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.Group.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.util.item.Group.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.Group.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.Group.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.Group.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.Group.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.scene

type: property

modo.util.item.Group.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.Group.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Group.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Group.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.util.item.GroupLocator

type: type

doc: Group locator item class. Takes an optional 'grploc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Group locator' or an item name or ID to look up. If no grploc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param grploc: Optional group locator item object (type lx.symbol.sITYPE_GROUPLOCATOR) or string (item name or ID) to look up. :type grploc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid group locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'group locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the grploc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator._item

type: property

modo.util.item.GroupLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.GroupLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.GroupLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.GroupLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.GroupLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.GroupLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.GroupLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.GroupLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.GroupLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.GroupLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.GroupLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.GroupLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.GroupLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.GroupLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.GroupLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.GroupLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.GroupLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.GroupLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.GroupLocator.scene

type: property

modo.util.item.GroupLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.GroupLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.GroupLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.GroupLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.GroupLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Item

type: type

doc: Base item class Takes an optional lx.object.Item object as an argument. If none is provided (the default) then the most recently selected item is used. :param item: Optional item object to wrap. :type item: an instance of lx.object.Item or lxu.object.item :raises ValueError: if no item is passed as an argument and no valid items are currently selected. :raises LookupError: if a string (item name or ID) is passed as the item argument and no item with that name or ID cane be found in the scene. :raises TypeError: if the object passed as the 'item' argument isn't an instance of lx.object.Item.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item._item

type: property

modo.util.item.Item._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.Item.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.Item.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.Item.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.Item.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.Item.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.Item.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.Item.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.Item.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.Item.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.Item.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.Item.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.Item.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.Item.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.Item.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.scene

type: property

modo.util.item.Item.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.Item.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Item.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Item.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.ItemGraph

type: type

doc: Utility container class for quick access to ItemGraph compatible graphs :param item: Item to look up graph for :param ls.symbol.sGRAPH_* graphType: Graph to look up. Common ones are 'parent', 'deformers', 'groups', 'chanMods' :param bool reverse: Indices traverse the graph forwards if false or reverse if true

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ItemGraph._ItemGraph__toType

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ItemGraph.connectedItems

type: property

doc: :getter: Returns a dictionary that lists the input- and output items at once. :rtype: dictionary

modo.util.item.ItemGraph.connectInput(self,other)

type: instancemethod

doc: Connects the given item as input. This function is called by the >> operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ItemGraph.disconnectInput(self,other)

type: instancemethod

doc: Removes the given item from the input connections if any. This function is called by the << operator. :param Item other: Can be any type derived from Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ItemGraph.forward(self,index)

type: instancemethod

doc: :returns list: Items of the forward connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ItemGraph.item

type: property

doc: :getter: Returns the Item that this ItemGraph instance is bound to. :return type: Item

modo.util.item.ItemGraph.reverse(self,index)

type: instancemethod

doc: :returns list: Items of the reverse connections

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ItemGraph.setReverse(self,reverse)

type: instancemethod

doc: Sets the direction that is used for lookup when using the angular brackets [] :param bool reverse: If True the graph is looked up forwards, if False, backwards.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.ItemGraph.type

type: property

doc: :getter: Returns the name of the graph type that this instance represents. :return type: basestring

modo.util.item.Iterable

type: ABCMeta

file: E:\Program Files\Luxology\modo\902\extra\Python\lib\_abcoll.pyc

modo.util.item.Joint

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint._item

type: property

modo.util.item.Joint._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.Joint.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.Joint.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.Joint.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.Joint.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.Joint.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.Joint.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.Joint.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.Joint.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.Joint.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.Joint.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.Joint.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.Joint.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.Joint.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.Joint.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Joint.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Joint.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Joint.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Joint.scene

type: property

modo.util.item.Joint.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.Joint.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Joint.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Joint.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.Joint.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Keyframes

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Keyframes._indexFromTime(self,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Keyframes.add(self,val,time)

type: instancemethod

doc: Adds a new keyframe at the specified time. If no time value is passed as an argument a keyframe is set at the current time. :param time: optional time (in seconds) to add a keyframe at. :type time: float :param val: the value to set for the keyframe :type val: int or float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Keyframes.delete(self)

type: instancemethod

doc: Deletes the current key

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Keyframes.first(self)

type: instancemethod

doc: Go to the first keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Keyframes.getSlopeType(self,side)

type: instancemethod

doc: Returns the slope type for either side of a keyframe. :returns: a tuple of the slope type set for the side of the keyframe specified and whether the slope is weighted or not. :rtype: (int, int)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Keyframes.last(self)

type: instancemethod

doc: Go to the last keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Keyframes.next(self)

type: instancemethod

doc: Go to the next keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Keyframes.numKeys

type: property

doc: :getter: Returns the number of keyframes found :rtype: int

modo.util.item.Keyframes.prev(self)

type: instancemethod

doc: Go to the previous keyframe.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Keyframes.setIndex(self,index)

type: instancemethod

doc: Go to the keyframe by index

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Keyframes.setSlopeType(self,stype,side)

type: instancemethod

doc: Sets the slope type for either side of a keyframe - **SLOPE_DIRECT** the slope of the tangent is set based on the value stored in the key. - **SLOPE_AUTO** the slope of the tangent is calculated automatically with regard to surrounding keys. This is similar to the slope adjustments made by TCB curves. - **SLOPE_LINEAR_IN** the slope of the tangent is calculated to align with the previous key's value. - **SLOPE_LINEAR_OUT** the slope of the tangent is calculated to align with the next key's value. - **SLOPE_FLAT** The slope of the tangent is set to zero. - **SLOPE_AUTOFLAT** the same as auto but if a neighboring key has the same value as the key the slope is set to zero. - **SLOPE_STEPPED** Maintains the value of the previous key between pairs of keys. :param stype: set the slope type for the current keyframe. Can be one of: | lx.symbol.iSLOPE_AUTO | lx.symbol.iSLOPE_AUTOFLAT | lx.symbol.iSLOPE_DIRECT | lx.symbol.iSLOPE_FLAT | lx.symbol.iSLOPE_LINEAR_IN | lx.symbol.iSLOPE_LINEAR_OUT | lx.symbol.iSLOPE_STEPPED :type stype: int :param side: the side of the key (in or out) the slope type is being set for :type side: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.Keyframes.time

type: property

doc: Returns & sets the time for the current keyframe. :setter: Sets the time :param time: the time to move the key to. :type time: float :getter: Returns the time of the current keyframe :rtype: float

modo.util.item.Keyframes.value

type: property

doc: Convenience property to get & set value of the current keyframe for the 90% case of an unbroken key. :setter: Sets a value :param val: the value to set for the key. :type val: int or float :getter: Returns the value of an (unbroken) key. :rtype: int or float

modo.util.item.Light

type: type

doc: Base Light item class. Each light item encapsulates both an lx.object.Item object (via inheritance from the Item class) of a specific modo light type and a corresponding lx.object.Item of type 'lightMaterial' as a :class:`LightMaterial` object via the light's material property. example:: # to set the diffuse color on the currently selected spotlight spotlight = modo.SpotLight() spotlight.material.ch_diffCol.set((0.7, 0.1, 0.5)) .. note:: Although "Light" isn't technically a base class since, like all other classes in modo.item, it inherits from "Item", it does encapsulate modo's 'Light" supertype and can be treated as a kind of 'pseudo' base class for all modo's light types. As such it should not be instantiated directly, create one of the specific light types instead. | :param light: Optional light item object to wrap. Must be a specific type of light, not the light supertype. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid light item selected. :raises TypeError: if the item passed as an argument isn't an instance of a specific subclass of Light.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light._item

type: property

modo.util.item.Light._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.Light.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.Light.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.Light.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.Light.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.Light.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.Light.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.Light.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.Light.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.Light.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.Light.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.util.item.Light.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.Light.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.Light.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.Light.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.Light.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Light.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Light.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Light.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Light.scene

type: property

modo.util.item.Light.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.Light.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Light.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Light.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.Light.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.LightMaterial

type: type

doc: Wraps a light material texture layer item. :param material: the light material item to be wrapped. :type material: lx.object.Item of type lx.symbol.sITYPE_LIGHTMATERIAL

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial._item

type: property

modo.util.item.LightMaterial._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.LightMaterial.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.LightMaterial.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.LightMaterial.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.LightMaterial.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.LightMaterial.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.LightMaterial.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.LightMaterial.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.LightMaterial.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.LightMaterial.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.LightMaterial.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.light

type: property

doc: :getter: The light item that the material belongs to. :param light_item: the light item to parent the material layer to. :type light_item: an instance of one of the modo.Light types or either lx.object.Item or lxu.object.Item of a specific light item type :returns: the parent light item. :rtype: one of the modo light types.

modo.util.item.LightMaterial.lightCol

type: property

doc: A wrapper property for the light material item's three diffuse color channels. Returns an :class:`modo.channel.Channel` object :getter: Returns a channelTriple object. :rtype: modo.channel.channelTriple

modo.util.item.LightMaterial.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.LightMaterial.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.LightMaterial.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.LightMaterial.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.LightMaterial.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.scatteringCol

type: property

doc: :getter: A wrapper property for the light material item's three scattering color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.util.item.LightMaterial.scene

type: property

modo.util.item.LightMaterial.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.LightMaterial.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LightMaterial.shadCol

type: property

doc: :getter: A wrapper property for the light material item's three shadow color channels. Returns an :class:`modo.channel.Channel` object :returns: a channelTriple object. :rtype: modo.channel.channelTriple

modo.util.item.LightMaterial.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.LightMaterial.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Locator

type: type

doc: Locator item class. Takes an optional 'locator' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'locator' or an item name or ID to look up. If no locator item is supplied as an argument an attempt will be made to wrap the most recently selected locator item. :param locator: Optional locator item object (type lx.symbol.sITYPE_LOCATOR) or string (item name or ID) to look up. :type locator: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the locator argument but no item with that name/ID can be found. Hint: Items of other locator derived types should be casted as LocatorSuperType, casting to this class will fail.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator._item

type: property

modo.util.item.Locator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.Locator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.Locator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.Locator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.Locator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.Locator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.Locator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.Locator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.Locator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.Locator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.Locator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.Locator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.Locator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.Locator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.Locator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Locator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Locator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Locator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Locator.scene

type: property

modo.util.item.Locator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.Locator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Locator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Locator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.Locator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.LocatorSuperType

type: type

doc: The LocatorSuperType reflects all items that can be seen and transformed in the 3d view. Locators have transform items that hold the respective transform channels, such as position and rotation.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType._item

type: property

modo.util.item.LocatorSuperType._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.LocatorSuperType.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.LocatorSuperType.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.LocatorSuperType.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.LocatorSuperType.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.LocatorSuperType.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.LocatorSuperType.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.LocatorSuperType.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.LocatorSuperType.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.LocatorSuperType.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.LocatorSuperType.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.LocatorSuperType.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.LocatorSuperType.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.LocatorSuperType.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.LocatorSuperType.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.LocatorSuperType.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.LocatorSuperType.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.LocatorSuperType.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.LocatorSuperType.scene

type: property

modo.util.item.LocatorSuperType.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.LocatorSuperType.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.LocatorSuperType.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.LocatorSuperType.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.LocatorSuperType.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Matrix4

type: type

doc: Matrix class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4._getIdentity

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4._matrix_calcRotation

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4._matrix_vectorMultiply

type: function

doc: :param matrix: :param vector: :param result: :return:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4._MatrixToEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4._rotOrderToList

type: function

doc: takes a string in form of 'xyz' and returns a list in form of [0,1,2]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4.asEuler(self,degrees,order)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4.asRotateMatrix(self)

type: instancemethod

doc: Removes the translation part of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4.copy(self)

type: instancemethod

doc: :return: A copy of this Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4.determinant(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4.fromEuler

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4.invert(self)

type: instancemethod

doc: Inverts this Matrix in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4.inverted(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4.position

type: property

doc: :getter: Returns the translation part of this matrix :rtype: tuple :setter: Sets the translation part of this matrix :param position: Position :type position: iterable

modo.util.item.Matrix4.scale(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4.set(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4.setIdentity(self)

type: instancemethod

doc: Set this matrix to it's identity

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4.transpose(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Matrix4.transposed(self)

type: instancemethod

doc: This function transposes a matrix, by flipping it across it's main diagonal. It returns a new transposed matrix.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Mesh

type: type

doc: Mesh item class. Takes an optional 'mesh' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'mesh' or an item name or ID to look up. If no mesh item is supplied as an argument an attempt will be made to wrap the most recently selected mesh layer. :param mesh: Optional mesh item object (type lx.symbol.sITYPE_MESH) or string (item name or ID) to look up. :type mesh: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid mesh item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'mesh' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the mesh argument but no item with that name/ID can be found. The mesh geometry can be accessed by the :class:`geometry` attribute. .. py:attribute:: geometry :rtype: :class:`MeshGeometry`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh._item

type: property

modo.util.item.Mesh._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.Mesh.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.Mesh.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.Mesh.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.Mesh.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.geometry

type: property

modo.util.item.Mesh.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.Mesh.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.Mesh.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.Mesh.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.Mesh.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.Mesh.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.Mesh.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.Mesh.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.Mesh.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.Mesh.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.Mesh.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Mesh.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Mesh.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Mesh.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Mesh.scene

type: property

modo.util.item.Mesh.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.Mesh.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Mesh.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Mesh.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.Mesh.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.MeshGeometry

type: type

doc: A class wrapped around lx.object.Mesh that provides access to geometry of a given Mesh Item :param item: Input item :type item: type lx.object.Item :param mode: Mode in which to access the mesh. Possible values: "write", "read", "deformed" :type mode: string. Note: References are always read only. :return: Instance of MeshGeometry :raises LookupError: If item was passed as string and could not be found in the scene :raises TypeError: If the passed item is not of type lx.object.Item :raises TypeError: If the passed item is not compatible with the mesh type example:: scene = modo.scene.current() # Get the selected mesh for mesh in scene.selectedByType("mesh")[:1]: # Print the number of vertices print len(mesh.geometry.vertices) # Print point position by index print mesh.geometry.vertices[4] # Set point position by index mesh.geometry.vertices[4] = (1,2,3) # Iterate all vertices and move them by 0.1 in x for point in mesh.geometry.vertices: point += (0.1, 0, 0) # Update to see mesh changes mesh.geometry.setMeshEdits() .. py:attribute:: vertices :rtype: :class:`MeshVertices` .. py:attribute:: edges :rtype: :class:`MeshEdges` .. py:attribute:: polygons :rtype: :class:`MeshPolygons` .. py:attribute:: vmaps :rtype: :class:`MeshMaps`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.util.item.MeshGeometry._item

type: property

modo.util.item.MeshGeometry._SEL_SVC

type: Selection

modo.util.item.MeshGeometry._UNDO_SVC

type: Undo

modo.util.item.MeshGeometry.accessMode

type: property

modo.util.item.MeshGeometry.boundingBox

type: property

doc: Get the bounding box of this mesh :getter: Returns a tuple representing the two corners of the bounding box

modo.util.item.MeshGeometry.getMeshCenter(self)

type: instancemethod

doc: :return: Center position of the bounding box

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.util.item.MeshGeometry.internalMesh

type: property

doc: :getter: Returns the wrapped lx.object.Mesh object

modo.util.item.MeshGeometry.numEdges

type: property

doc: :getter: returns the vertex count of this mesh

modo.util.item.MeshGeometry.numPolygons

type: property

doc: :getter: returns the polygon count of this mesh

modo.util.item.MeshGeometry.numVertices

type: property

doc: :getter: returns the vertex count of this mesh

modo.util.item.MeshGeometry.setAccessMode(self,value,time)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.util.item.MeshGeometry.setMeshEdits(self,editType)

type: instancemethod

doc: Updates mesh edits applying previous changes. :param lx.symbol.f_MESHEDIT_* editType: The type of change to set. Defaults to all.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.util.item.PhotometricLight

type: type

doc: Photometric (ies) light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Photometric Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Photometric Light item. :param light: Optional Photometric light item object (type lx.symbol.sITYPE_PHOTOMETRYLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Photometric light item selected. :raises TypeError: if the item passed as an argument isn't either a Photometric light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight._item

type: property

modo.util.item.PhotometricLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.PhotometricLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.PhotometricLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.PhotometricLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.PhotometricLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.PhotometricLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.PhotometricLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.PhotometricLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.PhotometricLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.PhotometricLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.PhotometricLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.util.item.PhotometricLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.PhotometricLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.PhotometricLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.PhotometricLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.PhotometricLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.PhotometricLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.PhotometricLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.PhotometricLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.PhotometricLight.scene

type: property

modo.util.item.PhotometricLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.PhotometricLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PhotometricLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.PhotometricLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.PhotometricLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.PointLight

type: type

doc: Point light item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Point Light' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Point Light item. :param light: Optional Point light item object (type lx.symbol.sITYPE_POINTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Point light item selected. :raises TypeError: if the item passed as an argument isn't either a Point light item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight._item

type: property

modo.util.item.PointLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.PointLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.PointLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.PointLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.PointLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.PointLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.PointLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.PointLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.PointLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.PointLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.PointLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.util.item.PointLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.PointLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.PointLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.PointLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.PointLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.PointLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.PointLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.PointLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.PointLight.scene

type: property

modo.util.item.PointLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.PointLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.PointLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.PointLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.PointLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Portal

type: type

doc: Portal item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Portal' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Portal item. :param light: Optional Portal item object (type 'portal') or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Portal item selected. :raises TypeError: if the item passed as an argument isn't either a Portal item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal._item

type: property

modo.util.item.Portal._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.Portal.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.Portal.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.Portal.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.Portal.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.Portal.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.Portal.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.Portal.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.Portal.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.Portal.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.Portal.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.util.item.Portal.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.Portal.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.Portal.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.Portal.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.Portal.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Portal.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Portal.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Portal.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.Portal.scene

type: property

modo.util.item.Portal.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.Portal.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.Portal.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.Portal.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.Portal.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.RenderPassGroup

type: type

doc: Render pass group :param groupItem: either a group item or an item name/ID to look up. :type groupItem: lx.object.item or modo.item.Item :raises TypeError: if the item is not a 'Group" item. :raises LookupError: if a name or ID is supplied as the groupItem argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup._item

type: property

modo.util.item.RenderPassGroup._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.addChannel(self,chan,item)

type: instancemethod

doc: Add a channel to the group. The supplied channel argument be a modo.channel.Channel() object, in which case no item argument is required or a channel name (string) or index (int), both of which require an additional 'item' argument. :param channel: the channel to add. :type channel: modo.channel.Channel() object, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.addItems(self,items)

type: instancemethod

doc: Add one or more items to the group if they're not already members. :param items: the item or items to add :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.addPass(self,name)

type: instancemethod

doc: Add a render pass item to the group. :param name: optional name for the render pass :type name: basestring :return: the render pass item. :rtype: modo.item.ActionClip

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.RenderPassGroup.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.RenderPassGroup.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.RenderPassGroup.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.RenderPassGroup.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.getItemAt(self,index)

type: instancemethod

doc: Gets the item at the specified index. :returns: item at the specified index. :rtype: modo.item.Item :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.getItemIndex(self,item)

type: instancemethod

doc: Index of the item within the groups list of items. :return: item index in the group. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.groupChannelCount

type: property

doc: The number of channels in the group. :getter: Returns the number of channels in the group. :rtype: int

modo.util.item.RenderPassGroup.groupChannels

type: property

doc: returns a list of all the channels in the group. Each element of the list will be an modo.channel.Channel :getter: Returns a list of channels. :rtype: list of modo.channel.Channel items

modo.util.item.RenderPassGroup.groupGetChannelAt(self,index)

type: instancemethod

doc: Gets the channel at the specified index. :returns: the channel at the specified index. :rtype: modo.channel.Channel :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.groupRemoveChannelAt(self,index)

type: instancemethod

doc: Removes the channel at the specified index from the group's list of channels. :param index: index of the channel in the group's list of channels. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.hasChannel(self,chan,item)

type: instancemethod

doc: Check to see if the specified channel is a member of the group. The supplied channel argument be a :class:`modo.channel.Channel` object, in which case no item argument is required, a channel name (string) or index (int), both of which require an additional 'item' argument. :param chan: the channel to check :type chan: modo.channel.Channel, int or basestring :param item: the item to which the channel belongs. Not required if a Channel() object is provided as the first argument. :type item: modo.item.Item :returns: True if the channel is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.hasItem(self,item)

type: instancemethod

doc: :param item: :type item: :returns: True if the item is in the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.RenderPassGroup.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.RenderPassGroup.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.RenderPassGroup.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.RenderPassGroup.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.itemCount

type: property

doc: The number of items in the group :getter: Returns the number of items :rtype: int

modo.util.item.RenderPassGroup.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.RenderPassGroup.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.RenderPassGroup.items

type: property

doc: Get a list of the items in the group. :returns: the items in the group. :rtype: list

modo.util.item.RenderPassGroup.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.RenderPassGroup.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.RenderPassGroup.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.RenderPassGroup.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.RenderPassGroup.passes

type: property

doc: :getter: Returns a lst of render passes in the group. :returns: list of render pass items :rtype: list of modo.item.ActionClip

modo.util.item.RenderPassGroup.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.removeChannel(self,chan,item)

type: instancemethod

doc: Remove a channel from the group. The supplied channel argument can either be a channel name (string) or index (int). :param item: the item to which the channel belongs. :type item: modo.item.Item :param channel: the channel to remove. :type channel: int or basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.removeItemAt(self,index)

type: instancemethod

doc: Removes the item at the specified index from the group's list of items. :param index: index of the item in the group's list of items. :type index: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.removeItems(self,items)

type: instancemethod

doc: Remove one or more items from the group, if they exis. :param items: the item or items to remove. :type items: modo.item.Item or list of modo.item.Item objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.scene

type: property

modo.util.item.RenderPassGroup.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.RenderPassGroup.setItemIndex(self,item,index)

type: instancemethod

doc: Set's the index for the specified item in the list of items within the group. :param item: the item to move :type item: modo.item.Item :param index: the index in the list of items belonging to the group to move the item to. :type index: int :raises ValueError: if index is less than zero.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.RenderPassGroup.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.RenderPassGroup.type

type: property

doc: Get or set the group type. If the group is a general group it has no type so returns None. :getter: Returns the type of the group. :rtype: basestring or None :raises ValueError: if the supplied argument isn't one of the default group type strings. :setter: Sets the group type :param gtype: either one of the available group types - 'assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader' to define the group as one of the built in types or any other string to define the group as a custom type of your own. :type gtype: basestring

modo.util.item.scene

type: module

doc: .. module:: modo.scene :synopsis: Scene class and scene level utility functions. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.c

type: Module

doc: .. module:: modo.constants :synopsis: Constants & defines used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

modo.util.item.scene.ChannelRead

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.util.item.scene.ChannelRead contents:
  • modo.util.item.scene.ChannelRead.__class__
  • modo.util.item.scene.ChannelRead.__delattr__
  • modo.util.item.scene.ChannelRead.__dict__
  • modo.util.item.scene.ChannelRead.__doc__
  • modo.util.item.scene.ChannelRead.__format__
  • modo.util.item.scene.ChannelRead.__getattr__
  • modo.util.item.scene.ChannelRead.__getattribute__
  • modo.util.item.scene.ChannelRead.__hash__
  • modo.util.item.scene.ChannelRead.__init__
  • modo.util.item.scene.ChannelRead.__module__
  • modo.util.item.scene.ChannelRead.__new__
  • modo.util.item.scene.ChannelRead.__reduce__
  • modo.util.item.scene.ChannelRead.__reduce_ex__
  • modo.util.item.scene.ChannelRead.__repr__
  • modo.util.item.scene.ChannelRead.__setattr__
  • modo.util.item.scene.ChannelRead.__sizeof__
  • modo.util.item.scene.ChannelRead.__str__
  • modo.util.item.scene.ChannelRead.__subclasshook__
  • modo.util.item.scene.ChannelRead.__weakref__
  • modo.util.item.scene.ChannelRead.set

modo.util.item.scene.ChannelRead.set(self,action,time)

type: instancemethod

doc: Initialises the channel read object with a new action and/or an explicit time to read from. If no action is provided the last action set is used. If no time value is provided the current time is used. :param action: optional action to read from. :type action: basestring :param time: optional time (in seconds) to read at. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.scene.ChannelWrite

type: type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

    modo.util.item.scene.ChannelWrite contents:
  • modo.util.item.scene.ChannelWrite.__class__
  • modo.util.item.scene.ChannelWrite.__delattr__
  • modo.util.item.scene.ChannelWrite.__dict__
  • modo.util.item.scene.ChannelWrite.__doc__
  • modo.util.item.scene.ChannelWrite.__format__
  • modo.util.item.scene.ChannelWrite.__getattr__
  • modo.util.item.scene.ChannelWrite.__getattribute__
  • modo.util.item.scene.ChannelWrite.__hash__
  • modo.util.item.scene.ChannelWrite.__init__
  • modo.util.item.scene.ChannelWrite.__module__
  • modo.util.item.scene.ChannelWrite.__new__
  • modo.util.item.scene.ChannelWrite.__reduce__
  • modo.util.item.scene.ChannelWrite.__reduce_ex__
  • modo.util.item.scene.ChannelWrite.__repr__
  • modo.util.item.scene.ChannelWrite.__setattr__
  • modo.util.item.scene.ChannelWrite.__sizeof__
  • modo.util.item.scene.ChannelWrite.__str__
  • modo.util.item.scene.ChannelWrite.__subclasshook__
  • modo.util.item.scene.ChannelWrite.__weakref__
  • modo.util.item.scene.ChannelWrite.set

modo.util.item.scene.ChannelWrite.set(self,action,time)

type: instancemethod

doc: Initialises the channel write object with an action and/or a time write to. Defaults to writing to the "edit" action if no action is provided and to the current time if no time is provided. :param action: the action to write to. :type action: basestring :param time: the time to write to in seconds. :type time: float

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\channel.py

modo.util.item.scene.current

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.fnmatch

type: function

doc: Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN).

file: .\Lib\fnmatch.py

modo.util.item.scene.item

type: module

doc: .. module:: modo.item :synopsis: Item classes. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.scene.Scene

type: type

doc: The main scene class. Takes an optional lx.object.Scene object as an argument. If none is provided (the default) then the currently selected scene is used which will mostly be the general case. The module function :func:`sceneList` makes use of the scene parameter to return a list of open scenes as modo.scene.Scene objects. :param scene: Optional scene object to wrap. :type scene: lx.object.Scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene._allItems(self)

type: instancemethod

doc: Utility function to get all items of a scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene._Scene__ItemAdd(self,groupType)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene._Scene__setupTextureLayerType(self,newItem)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.actors

type: property

doc: Returns a list of all actors in the scene :getter: Returns a list of Actor objects found in this scene :rtype: list

modo.util.item.scene.Scene.addActor(self,name,items,makeActive)

type: instancemethod

doc: Add a new actor to the scene :returns modo.item.Actor: Actor item object :param basestring name: optional name :param list items: list of items for the actor to contain

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.addCamera(self,name)

type: instancemethod

doc: Add a new camera item to the scene :returns: camera item :rtype: modo.item.Camera :param name: optional name for the camera. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.addGroup(self,name,gtype)

type: instancemethod

doc: Add a new group item to the scene :returns: group item :rtype: modo.item.Group :param name: optional name for the group item. :type name: basestring :param gtype: optional group type, can be one of the default group types ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader') or any other string to create a custom group type. Default is an empty string which creates a 'Genera' group type. :type gtype: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.addItem(self,itype,name)

type: instancemethod

doc: Add a new item to the scene :returns: item :rtype: modo.item.item :param itype: item type :type itype: modo.Constant :param name: optional name for the item. :type name: basestring :raises TypeError: When failing

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.addJointLocator(self,name,parent)

type: instancemethod

doc: Adds a new joint to the scene

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.addMaterial(self,matType,name,index)

type: instancemethod

doc: Adds a new material to the scene :param modo.c.MATERIAL_* matType: Type of material to create :param name: Optional name for the material :returns Item: The material item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.addMesh(self,name)

type: instancemethod

doc: Add a new mesh item to the scene :returns: mesh item :rtype: modo.item.Mesh :param name: optional name for the mesh. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.addRenderPassGroup(self,name)

type: instancemethod

doc: Add a render pass group to the scene :returns: render pass group. :rtype: modo.item.RenderPassGroup :param name: optional name for the render pass group. :type name: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.camera(self,cam)

type: instancemethod

doc: Returns a camera item in the scene. The supplied argument can be either a string (camera ID or name) or an integer (camera index in the scene's collection of cameras) :param cam: the camera :type cam: basestring or int :returns: camera item :rtype: modo.item.Camera

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.cameraCount

type: property

doc: Number of cameras in the scene. :getter: Returns the number of camera items. :rtype: int

modo.util.item.scene.Scene.cameras

type: property

doc: Returns a list of all the camera items in the scene as modo.item.Camera objects. :getter: Returns a list of the camera items in the scene. :rtype: list of modo.item.Camera

modo.util.item.scene.Scene.currentRange

type: property

doc: Set or read the current frame range start and end frame value should be passed in as a tuple. :setter: Sets the range :param frange: frame range - a tuple of ints (start, end). :type frange: tuple :Getter: Returns the start and end frames. :rtype: tuple :exception ValueError: if supplied start frame is higher than end frame.

modo.util.item.scene.Scene.deformers(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.deselect(self,itemObj)

type: instancemethod

doc: Deselect an item. :param itemObj: the item to deselect. Clears the entire selection if None :type itemObj: basestring (item name or ID) or instance of either lx.object.Item or modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.duplicateItem(self,item,instance)

type: instancemethod

doc: Creates and returns a duplicate of the passed item :returns item: Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.filename

type: property

doc: File path of the scene. :getter: Returns the file path of the scene or 'None' if not yet saved. :rtype: basestring or None

modo.util.item.scene.Scene.fps

type: property

doc: Scene frames per second. .. note:: There is no way to set the fps value from the Python API for any scene other than the currently selected one. Therefore, for any other scene the property will be read only and attempts to write to it will throw an AttributeError. | :getter: Returns the Frames Per Second :rtype: float :setter: Sets the Frames Per Second :param fps: Scene frames per second. :type fps: float :raises: AttributeError

modo.util.item.scene.Scene.getGroups(self,gtype)

type: instancemethod

doc: Returns all groups of the given kind :param gtype: optional group type, can be one of the default group types ('assembly', 'actor', 'render', 'keyset', 'chanset', 'preset', 'shader') or any other string to create a custom group type. Default is an empty string which creates a 'Genera' group type. You can also pass a list of multiple group types. :returns list: List of groups matching the type

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.groups

type: property

doc: Returns a list of all the group items in the scene as modo.item.Group objects. :getter: Returns a list of the group items in the scene. :rtype: list of modo.item.Group

modo.util.item.scene.Scene.item(self,name)

type: instancemethod

doc: Look up item by name :param string item: Name to look for :returns item: Found item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.itemCount(self,itype)

type: instancemethod

doc: The number of items of a specified type in the scene. :param itype: type of the items. :type itype: int or basestring :returns: the number of items of the specified type in the scene. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.items(self,itype,name,superType)

type: instancemethod

doc: List of items of the specified type in the scene. :param itype: the item type. :type itype: :param basestring name: Optionally filter result by this text. Can use * and ? wildcards for globbing. :param bool superType: If True, all items that have 'itype' as superType are listed. Else, only items of specifically that type are returned. :returns: list of the items of the specified type in the scene. If itype is None, all items in the scene are returned. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.iterItems(self,itype,name,superType)

type: instancemethod

doc: Same as items(), but returns a generator object.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.lightCount

type: property

doc: Number of lights in the scene. :getter: Returns the number of light items. :rtype: int

modo.util.item.scene.Scene.locators

type: property

modo.util.item.scene.Scene.meshCount

type: property

doc: Number of mesh items in the scene. :getter: Returns the number of mesh items. :rtype: int

modo.util.item.scene.Scene.meshes

type: property

doc: Returns a list of all the mesh items in the scene as modo.item.Mesh objects. :getter: Returns a list of the mesh items in the scene. :rtype: list of modo.item.Mesh

modo.util.item.scene.Scene.name

type: property

doc: Friendly name of the scene. :getter: Returns the name of the scene. :rtype: basestring

modo.util.item.scene.Scene.removeItems(self,itm,children)

type: instancemethod

doc: :param Item: Item to remove from the scene :param bool children: If True, all found children are deleted also

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.renderCamera

type: property

doc: Get & set the scene's current render camera :setter: Set the scene's current render camera :param camera: the camera item to set as the current render camera. :type camera: lx.object.Item of type 'Camera' :getter: Returns the current render camera. :rtype: modo.Item.Camera

modo.util.item.scene.Scene.renderItem

type: property

doc: :getter: Returns the first found render item of the scene :rtype: Item

modo.util.item.scene.Scene.renderPassGroups

type: property

doc: Returns a list of all the render pass group items in the scene as modo.item.RenderPassGroup objects. :getter: Returns a list of the render pass group items in the scene. :rtype: list of modo.item.Group

modo.util.item.scene.Scene.sceneItem

type: property

doc: The scene's 'scene item' :getter: Returns the scene's scene item. :rtype: lxdt.item.Item (type lx.symbol.sITYPE_SCENE)

modo.util.item.scene.Scene.sceneRange

type: property

doc: Set or read the scene's frame range start and end frame value should be passed in as a tuple. :setter: Sets the range :param frange: frame range - a tuple of ints (start, end). :type frange: tuple :getter: Returns the start and end frames. :rtype: tuple :exception ValueError: if supplied start frame is higher than end frame.

modo.util.item.scene.Scene.select(self,itemObj,add)

type: instancemethod

doc: :param itemObj: the item to select. :type item: basestring (item name or ID) or instance of either lx.object.Item or modo.item.Item :param add: whether to add to the current selection, False replaces the current selection. :type add: bool Note:: To clear the selection of the scene, please use deselect() instead.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.Scene.selected

type: property

doc: Selected items in the scene. :getter: Returns the selected items :rtype: list

modo.util.item.scene.Scene.selectedByType(self,itype,superType)

type: instancemethod

doc: Returns the selected items of a specific type as modo.item.Item objects. :param itype: item type to filter on. :type itype: int or string :return: selcted items of specified type. :param bool superType: If True, all items derived fom itype are listed. Otherwise only items of the exact type of itype. :rtype: list of modo.item.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.sceneList

type: function

doc: Get a list of all the currently open scenes. :returns: Collection of currently open scenes as modo.scene.Scene objects. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\scene.py

modo.util.item.scene.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.util.item.SpotLight

type: type

doc: Spotlight item class. Takes an optional 'light' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Spotlight' or an item name or ID to look up. If no light item is supplied as an argument an attempt will be made to wrap the most recently selected Spotlight item. :param light: Optional Spotlight item object (type lx.symbol.sITYPE_SPOTLIGHT) or string (item name or ID) to look up. :type light: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid Spotlight item selected. :raises TypeError: if the item passed as an argument isn't either a Spotlight item or an item name or ID string. :raises LookupError: if a name or ID is supplied as the light argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight._item

type: property

modo.util.item.SpotLight._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.SpotLight.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.SpotLight.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.SpotLight.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.SpotLight.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.SpotLight.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.SpotLight.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.SpotLight.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.SpotLight.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.SpotLight.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.SpotLight.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.material

type: property

doc: The light material item associated with this light :type material: modo.item.LightMaterial :getter: the base light material (ie the light material at the bottom of the stack if there are more than one) for the light item. :rtype: modo.item.LightMaterial :setter: Parents a material to the light :param material: a material item to parent to the light

modo.util.item.SpotLight.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.SpotLight.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.SpotLight.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.SpotLight.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.SpotLight.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.SpotLight.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.SpotLight.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.SpotLight.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.SpotLight.scene

type: property

modo.util.item.SpotLight.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.SpotLight.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.SpotLight.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.SpotLight.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.SpotLight.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.TextureLocator

type: type

doc: Texture locator item class. Takes an optional 'texloc' argument which can be either an item object (lx.object.Item or lxu.object.Item) of type 'Texture locator' or an item name or ID to look up. If no texloc item is supplied as an argument an attempt will be made to wrap the most recently selected group locator item. :param texloc: Optional texture locator item object (type lx.symbol.sITYPE_TEXTURELOC) or string (item name or ID) to look up. :type texloc: an instance of lx.object.Item, lxu.object.item or modo.item.Item :raises ValueError: if no valid texture locator item selected. :raises TypeError: if the item passed as an argument isn't either an instance of lx.object.Item of type 'texture locator' or an item name or ID string. :raises LookupError: if a name or ID is supplied as the texloc argument but no item with that name/ID can be found.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator._item

type: property

modo.util.item.TextureLocator._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.TextureLocator.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.TextureLocator.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.TextureLocator.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.TextureLocator.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.TextureLocator.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.TextureLocator.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.TextureLocator.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.TextureLocator.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.TextureLocator.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.TextureLocator.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.TextureLocator.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.TextureLocator.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.TextureLocator.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.TextureLocator.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.TextureLocator.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.TextureLocator.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.TextureLocator.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.TextureLocator.scene

type: property

modo.util.item.TextureLocator.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.TextureLocator.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TextureLocator.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.TextureLocator.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.TextureLocator.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.TransformItem

type: type

doc: Contains a group of animatable transform channels of a locator object. It has convenience functions for access of the locator's position, rotation and scale. examples:: # We retrieve two meshes from the current scene by name, assuming they exist cube = modo.Mesh('Cube') sphere = modo.Mesh('Sphere') # Set rotation values cube.rotation.set(10, 20, 30, degrees=True) # Link the position.x channel of the sphere to to the position.x channel of the cube cube.position.y.setLink(0, sphere.position.x, 0) # Set position values to zero cube.position.clear() # Insert keyframe for rotation on frame 21 frame = lx.service.Value().FrameToTime(21) cube.rotation.insertKey(time=frame)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem._item

type: property

modo.util.item.TransformItem._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem._TransformItem__rotationType

type: long

modo.util.item.TransformItem._TransformItem__scaleType

type: long

modo.util.item.TransformItem._TransformItem__toDegrees

type: function

doc: Utility function to consume and process the 'degrees' argument for the set function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem._TransformItem__transformType(self)

type: instancemethod

doc: Utility function that returns the corresponding string value from __types, for later channel lookup

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem._TransformItem__translationType

type: long
modo.util.item.TransformItem._TransformItem__types type: dict

modo.util.item.TransformItem._TransformItem__types.clear()

type: builtin_function_or_method

doc: D.clear() -> None. Remove all items from D.

modo.util.item.TransformItem._TransformItem__types.copy()

type: builtin_function_or_method

doc: D.copy() -> a shallow copy of D

modo.util.item.TransformItem._TransformItem__types.fromkeys()

type: builtin_function_or_method

doc: dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v. v defaults to None.

modo.util.item.TransformItem._TransformItem__types.get()

type: builtin_function_or_method

doc: D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

modo.util.item.TransformItem._TransformItem__types.has_key()

type: builtin_function_or_method

doc: D.has_key(k) -> True if D has a key k, else False

modo.util.item.TransformItem._TransformItem__types.items()

type: builtin_function_or_method

doc: D.items() -> list of D's (key, value) pairs, as 2-tuples

modo.util.item.TransformItem._TransformItem__types.iteritems()

type: builtin_function_or_method

doc: D.iteritems() -> an iterator over the (key, value) items of D

modo.util.item.TransformItem._TransformItem__types.iterkeys()

type: builtin_function_or_method

doc: D.iterkeys() -> an iterator over the keys of D

modo.util.item.TransformItem._TransformItem__types.itervalues()

type: builtin_function_or_method

doc: D.itervalues() -> an iterator over the values of D

modo.util.item.TransformItem._TransformItem__types.keys()

type: builtin_function_or_method

doc: D.keys() -> list of D's keys

modo.util.item.TransformItem._TransformItem__types.pop()

type: builtin_function_or_method

doc: D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised

modo.util.item.TransformItem._TransformItem__types.popitem()

type: builtin_function_or_method

doc: D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

modo.util.item.TransformItem._TransformItem__types.setdefault()

type: builtin_function_or_method

doc: D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

modo.util.item.TransformItem._TransformItem__types.update()

type: builtin_function_or_method

doc: D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

modo.util.item.TransformItem._TransformItem__types.values()

type: builtin_function_or_method

doc: D.values() -> list of D's values

modo.util.item.TransformItem._TransformItem__types.viewitems()

type: builtin_function_or_method

doc: D.viewitems() -> a set-like object providing a view on D's items

modo.util.item.TransformItem._TransformItem__types.viewkeys()

type: builtin_function_or_method

doc: D.viewkeys() -> a set-like object providing a view on D's keys

modo.util.item.TransformItem._TransformItem__types.viewvalues()

type: builtin_function_or_method

doc: D.viewvalues() -> an object providing a view on D's values

modo.util.item.TransformItem.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.TransformItem.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.TransformItem.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.clear(self)

type: instancemethod

doc: Sets values to 1.0 if is a scaling transform and to 0.0 otherwise :param arguments: Same as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.TransformItem.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.TransformItem.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.get(self,time,action,degrees)

type: instancemethod

doc: Function to get the x, y and z-values of the locator at once. :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when getting rotation. :param keywords: Same as as :meth:`Channel.get` :returns tuple: x, y and z values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.TransformItem.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.TransformItem.insertKey(self,time,action)

type: instancemethod

doc: Inserts a keyframe on the respective x, y and z channels. :param float time: Time in seconds to create the new keys :param action: Action to create keys in.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.TransformItem.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.TransformItem.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.TransformItem.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.TransformItem.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.TransformItem.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.TransformItem.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.TransformItem.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.TransformItem.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.removeKey(self,time,action)

type: instancemethod

doc:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.scene

type: property

modo.util.item.TransformItem.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.TransformItem.set(self,values,time,key,action,degrees)

type: instancemethod

doc: Function to set the x, y and z-values of the locator at once. :param values: either three floats, or a list/tuple containing the x, y, z values to set :param bool degrees: If set, values are interpreted as degrees instead of radians. Only relevant when setting rotation. :param keywords: Same as as :meth:`Channel.set`

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItem.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.TransformItem.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.TransformItem.x

type: property

doc: Shortcut to the x channel of the locator :getter: :class:`Channel` :rtype: float

modo.util.item.TransformItem.y

type: property

doc: Shortcut to the y channel of the locator :getter: :class:`Channel` :rtype: float

modo.util.item.TransformItem.z

type: property

doc: Shortcut to the z channel of the locator :getter: :class:`Channel` :rtype: float

modo.util.item.TransformItems

type: type

doc: Container class for the stacked transform items of a Locator object. Transform items contain channels for either position, rotation or scale. The order of how they are processed can be changed and new transform items can be inserted or existing ones deleted. example:: scene = modo.scene.current() # Grab first selected object for item in scene.selected[:1]: # Print the amount of transform items print len(item.transforms) # Add a new position transform item position = item.transforms.insert('position', values=(1,0,0), name='New_Position') # Add a new scale transform item scale = item.transforms.insert('scale', values=(2,2,2), name='Scaled') # Swap the indices of the first two transform items item.transforms.reposition(0,1) # Delete item.transforms.delete(scale) # Clear values of all transforms for i in item.transforms: i.clear()

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems._getChannelValuesAsDict(self,chNames,time,action)

type: instancemethod

doc: Note: ignores non-numerical and non-string types This method is marked as private because it is likely to be moved somewhere else :arg list chNames: Optional list of channel names to receive. If None, all channels are retrieved. :arg float time: Time to get the values at. Default to the current time if None :arg string action: Action to get the values from (optional) :returns dict: A dictionary containing the values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems._item

type: property

modo.util.item.TransformItems._Item__descendants(self,itemType)

type: instancemethod

doc: :returns list: list of all descendant children

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems._LocatorSuperType__getTransformitem(self,symbol)

type: instancemethod

doc: Utility function to get an 'internal' position, rotation or scale transform item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems._setChannelValuesFromDict(self,pairs,time,key,action)

type: instancemethod

doc: Set channel values from a provided dictionary This method is marked as private because it is likely to be moved somewhere else

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.baseName

type: property

doc: :getter: Item's base name. :return: item's base name before disambiguation. :rtype: basestring

modo.util.item.TransformItems.channel(self,channelName)

type: instancemethod

doc: Returns a channel object for the channel name provided. :param channelName: name of the channel. :type channelName: basestring :returns: a channel object for the specified channel :rtype: modo.channel.Channel. :raises LookupError: if the channel can not be found

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.channelNames

type: property

doc: :getter: Returns a list of all the names of the channels belonging to an object. :returns: list of channel names. :rtype: list

modo.util.item.TransformItems.channels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.childAtIndex(self,index)

type: instancemethod

doc: Returns the child item at the specified index. :param index: the child's index. :type index: int :returns: the child item at the specified index. :rtype: an instance of one of the defined modo.Item subtypes or an modo.Item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.childCount(self)

type: instancemethod

doc: returns the number of children an item has. :returns: the number of child items the item has. :rtype: int

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.children(self,recursive,itemType)

type: instancemethod

doc: Returns a list of the child items of this item. Each type of each of the returned child items will be one of the item types supported by the :meth:`modo.util.typeToFunc` method if possible, or an object of type lx.item.Item otherwise. :param bool recursive: Returns all childen's children if True. :returns: the children of the item. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.childrenByType(self,itype)

type: instancemethod

doc: Returns all the children of an item that are of the specified type. :param itype: the type of the children to return :type itype: int or basestring :returns: list of all the children of the specified type. :rtype: list

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.connectedGroups

type: property

doc: :getter: Returns a tuple of all Group objects that this item belongs to :rtype: tuple

modo.util.item.TransformItems.deformers

type: property

doc: :getter: Returns input connections of the 'deformers' graph :param basestring dtype: Optionally filter the result by this type. :returns tuple: Deformer items

modo.util.item.TransformItems.delete(self,index)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.deselect(self)

type: instancemethod

doc: Deselects this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.getTags(self,values)

type: instancemethod

doc: Get the string tags attached to an item. if 'values' is True (default) a dictionary of tag name/tag value pairs is returned, if 'values' is False a list of tag names is returned instead. :returns: the string tags attached to the item. :rtype: dictionary or list.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.hasTag(self,tagName)

type: instancemethod

doc: Returns whether the tag with the specified name exists or not. :param tagName: the four character tag ID :type tagName: basestring :returns: True if the specified tag exists on the group, False if not. :rtype: bool

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.id

type: property

doc: :getter: Item's unique ID (Ident) :return: ID :rtype: basestring

modo.util.item.TransformItems.idNames(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.index

type: property

doc: :getter: Index of the item in the collection of items of the same type in the scene. :return: Returns item index by type. :rtype: int

modo.util.item.TransformItems.insert(self,xfrmType,placement,values,name)

type: instancemethod

doc: Insert a new transform item into the transform chain. The 'prepend' and 'append' placement values place the new item at the top or bottom of the stack, where 'pre' and 'post' place it around the respective transform highlighted in black in the channel view. I am myself confused about the order though, is it bottom to top or the other way around? Note that modo always keeps at least one of each type of transform, so when you attempt to delete it a new one is created automatically. :param string xfrmType: 'position', 'rotation' or 'scale' :param string placement: 'prepend', 'append', 'pre' or 'post' :param tuple values: Initial xyz values to be optionally set :param string name: Optional name

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.internalItem

type: property

doc: :getter: Returns the internal Modo item embedded in this object

modo.util.item.TransformItems.isAnInstance

type: property

doc: :getter: Returns True if item is an instance of another item, False otherwise. :rtype: bool

modo.util.item.TransformItems.isLocatorSuperType(self)

type: instancemethod

doc: :returns bool: whether this item derives from the locator type.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.itemGraph(self,graphType,reverse)

type: instancemethod

doc: Retrieve ItemGraph by name :returns ItemGraph:

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.itemGraphNames

type: property

doc: :getter: Get connected ItemGraph names :returns list of strings: List of connected graph types :type: list

modo.util.item.TransformItems.itemGraphs

type: property

doc: :getter: Returns list of connected ItemGraphs :rtype: list

modo.util.item.TransformItems.iterChannels(self,name)

type: instancemethod

doc: Returns a generator object for iterating all channels of this item :returns generator object: iterable of channel objects

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.name

type: property

doc: :getter: Item's name. :return: Item's unique (disambiguated) name :rtype: string :param name: Item's base name - before disambiguation. :type: basestring

modo.util.item.TransformItems.names(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.packageNames(self)

type: instancemethod

doc: :returns list: Package names that are attached to this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.parent

type: property

doc: :getter: Item parent When setting accepts either an item object (modo.Item or lx.object.Item) or a string (item ID or name). :return: parent item or None if the item has no parent :rtype: modo.item.Item :param parent: item to parent to :type parent: basestring, modo.Item or lx.object.Item :raises LookupError: if the argument was a string and no item with that name or id can be found.

modo.util.item.TransformItems.parentIndex

type: property

doc: :getter: Returns the index of this item from from the perspective of it's parent This correlates to the order items appear in the UI, i.e. the item view and Shader Tree :returns int: Index

modo.util.item.TransformItems.parents

type: property

doc: :getter: Returns list of all ancestor parents :rtype: tuple

modo.util.item.TransformItems.pivot

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.TransformItems.position

type: property

doc: :getter: Returns a position TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.TransformItems.readTag(self,tagName)

type: instancemethod

doc: Get the value of a string tag attached to the item. :param tagName: the four character tag ID. :type tagName: basestring :returns: the value of the specified tag. :rtype: string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.reposition(self,indexFrom,indexTo)

type: instancemethod

doc: Places a transform item to the provided index of the transform item stack :param int indexFrom: Source Index of the item that is to be moved :param int indexTo: Destination index to place item at

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.rotation

type: property

doc: :getter: Returnsa rotation TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.TransformItems.scale

type: property

doc: :getter: Returns a scale TransformItem object. An appropriate channel is created if it does not exist. :rtype: :class:`TransformItem`

modo.util.item.TransformItems.scene

type: property

modo.util.item.TransformItems.select(self,replace)

type: instancemethod

doc: Selects this item :param bool replace: If True, the selection is cleared before selecting this item

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.selected

type: property

doc: :getter: Returns True if this item is selected, False otherwise :type: bool

modo.util.item.TransformItems.setParent(self,newParent,index)

type: instancemethod

doc: Parents this item to another :param modo.item.Item newParent: Item to parent to. If None, the item is parented to root level. :param int index: Optionally sets the position the item appears in the item view for locatorSuperType items Note that this method does not preserve world transformations as in parenting in place. Please use the command 'item.parent' instead

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.setTag(self,tagName,tagval)

type: instancemethod

doc: Create or set a string tag on to the item. :param tagName: the four character tagID. :type tagName: basestring :param tagval: The string value to be stored under the tag. Pass None to remove the tag. :type tagval: basestring

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\item.py

modo.util.item.TransformItems.superType

type: property

doc: :getter: Returns the parent type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.TransformItems.transforms

type: property

doc: :getter: Access to the stacked transform items. :rtype: :class:`TransformItems`

modo.util.item.TransformItems.type

type: property

doc: :getter: Returns the type of the item as a string. :return: the type of the item. :rtype: basestring

modo.util.item.util

type: module

doc: .. module:: modo.util :synopsis: A collection of support tools, decorators, functions etc used by the other modules in the package. .. moduleauthor:: Gwynne Reddick

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.util.item.Vector3

type: type

doc: Vector3 class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.angle(self,other)

type: instancemethod

doc: Returns the angle between this and another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.copy(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.cross(self,other)

type: instancemethod

doc: Returns a new vector with the result of crossing this vector with another

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.distanceBetweenPoints(self,other)

type: instancemethod

doc: Returns the distance between this and another point

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.dot(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.equals(self,other,tolerance)

type: instancemethod

doc: Returns if this vector is equivalent to another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.length(self)

type: instancemethod

doc: Returns the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.mulByMatrixAsPoint(self,other)

type: instancemethod

doc: Transform this point's position by a Matrix4 in place. :param Matrix4 other: Other Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.normal(self)

type: instancemethod

doc: Returns a normalized copy of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.normalize(self)

type: instancemethod

doc: Normalizes this vector in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.rotate(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.rotateByAxisAngle(self,axis,angle)

type: instancemethod

doc: Rotates this vector by a given axis and angle :param Vector3 axis: This axis to rotate about :param float angle: The angle in radians to rotate by

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.rotateByQuat(self,other)

type: instancemethod

doc: Rotate this vector by a quaternion

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.setLength(self,value)

type: instancemethod

doc: Sets the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.util.item.Vector3.x

type: property

doc: Quick access to the x component of the vector

modo.util.item.Vector3.y

type: property

doc: Quick access to the y component of the vector

modo.util.item.Vector3.z

type: property

doc: Quick access to the z component of the vector

modo.util.makeQuickCommand

type: function

doc: Quick way to create a command. Note that a command can only be blessed (registered) once per modo session, so this command will fail when attempting to rebless a command. :param string name: Name that the command will be callable by. Example: cmds.myCommand :param function func: The function that the command should call :param iterable arguments: A sequence of name:defaultvalue pairs to make arguments that will be passed on to the function :param basestring userName: The user name :param basestring description: Summary of the command's purpose :param basestring toolTip: Text that appears when hovering over the button example:: import modo def func_args(mystring, myint): print mystring, myint def func_simple(): print 'simple function, no arguments' modo.util.makeQuickCommand('test.simple', func_simple) modo.util.makeQuickCommand('test.args', func_args, (('mystring', 'mesh021'), ('myint', 23))) lx.eval('test.simple') lx.eval('test.args mesh022 24')

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.util.paths

type: function

doc: Access to various system paths. :param basestring key: Specific path to return. Returns all if None. :returns dictionary or string: Dictionary containing all paths or single path as string

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.util.testGlobalInterpreter

type: function

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.util.typeToFunc

type: function

doc: selects an item class constructor based on the item type passed as an argument and returns that as a class instantiation 'function' object to call the correct class in methods that eg select by item type or return items. In essence it acts as a sort of clearing house to try to ensure that any recognised but unwrapped items are wrapped with the correct modo.item.xxx type before being returned. example usage:: # get a list of all the light items in a scene where each light in the list is returned as the correctly # wrapped modo version of each light sub-type. import modo scene = modo.Scene() lights = [] for light in scene.ItemList(modo.c.LIGHT_TYPE): func = modo.c.typeToFunc(light.Type()) lights.append(func(light)) # or more succinctly as a list comprehension: lights = [modo.c.typeToFunc(light.Type())(light) for light in scene.ItemList(modo.c.LIGHT_TYPE)]

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\util.py

modo.UVMap

type: type

doc: Access for UV-Map values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.UVMap._accessor

type: property

modo.UVMap._setValue(self,vertexIndex,values,nonContinuous)

type: instancemethod

doc: Sets UV values for this vertex. :param int vertexIndex: Index of vertex to change the UV values for :param tuple values: The u and v values to set (pair consisting of of 2 floats) :param bool nonContinuous: If True, the values are applied to all non-continuous occurrences on polygons found for this vertex. If False, Nothing happens when the vertex has non-continuous UVs.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.UVMap._UVMap__get(self,point_index,listContinuous,listNonContinuous)

type: instancemethod

doc: Get the u and v value from a point A vertexuv pair is continuous if it's uv values are shared by multiple polygons. :param int point_index: Index of the vertex to get the uv value from :param bool listContinuous: Skips vertices with continuous uvs if False. :param bool listNonContinuous: Skips vertices with non-continuous uvs if False. :returns: A tuple containing the u and v values

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.UVMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.UVMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.UVMap.continuousVertices(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.UVMap.disContinuousVertices(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.UVMap.fromMesh(cls)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.UVMap.id

type: property

modo.UVMap.iterContinuousVertices(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.UVMap.iterDisContinuousVertices(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.UVMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.Vector3

type: type

doc: Vector3 class

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.angle(self,other)

type: instancemethod

doc: Returns the angle between this and another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.copy(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.cross(self,other)

type: instancemethod

doc: Returns a new vector with the result of crossing this vector with another

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.distanceBetweenPoints(self,other)

type: instancemethod

doc: Returns the distance between this and another point

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.dot(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.equals(self,other,tolerance)

type: instancemethod

doc: Returns if this vector is equivalent to another vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.length(self)

type: instancemethod

doc: Returns the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.mulByMatrixAsPoint(self,other)

type: instancemethod

doc: Transform this point's position by a Matrix4 in place. :param Matrix4 other: Other Matrix

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.normal(self)

type: instancemethod

doc: Returns a normalized copy of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.normalize(self)

type: instancemethod

doc: Normalizes this vector in place

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.rotate(self,other)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.rotateByAxisAngle(self,axis,angle)

type: instancemethod

doc: Rotates this vector by a given axis and angle :param Vector3 axis: This axis to rotate about :param float angle: The angle in radians to rotate by

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.rotateByQuat(self,other)

type: instancemethod

doc: Rotate this vector by a quaternion

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.setLength(self,value)

type: instancemethod

doc: Sets the length of this vector

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\mathutils.py

modo.Vector3.x

type: property

doc: Quick access to the x component of the vector

modo.Vector3.y

type: property

doc: Quick access to the y component of the vector

modo.Vector3.z

type: property

doc: Quick access to the z component of the vector

modo.VertexMap

type: type

doc: A class representing a vertex map, accessible by point indices through angular brackets. Base class for other maps.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.VertexMap._accessor

type: property

modo.VertexMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.VertexMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.VertexMap.fromMesh(cls,geometry,accessor,ID,map_type,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.VertexMap.id

type: property

modo.VertexMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.VertexNormalMap

type: type

doc: Vertex Normal Map class * Available from Modo 901 SP1 and upwards * Allows manipulation of a vertex normal map on either vertex or polygon basis. Example:: import modo reload(modo) # Create a subdivided cube lx.eval('script.implicit {Unit Cube Item}') lx.eval('poly.subdivide ccsds') mesh = modo.Mesh('Cube') # Create a vertex normal map normals = mesh.geometry.vmaps.addVertexNormalMap() normalValue = (0, 0, -1) # Set the normal value on every vertex per polygon for polygon in mesh.geometry.polygons: for vert in polygon.vertices: normals.setNormal( normalValue, vert, polygon) # Update the mesh mesh.geometry.setMeshEdits(lx.symbol.f_MESHEDIT_MAP_OTHER) # Select the vertex normal map to see the effect lx.eval('select.vertexMap "%s" norm replace' % normals.name)

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.VertexNormalMap._accessor

type: property

modo.VertexNormalMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.VertexNormalMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.VertexNormalMap.fromMesh(cls)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.VertexNormalMap.getNormal(self,vertex,polygon)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.VertexNormalMap.id

type: property

modo.VertexNormalMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string

modo.VertexNormalMap.setNormal(self,values,vertex,polygon,normalize)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.WeightMap

type: type

doc: Provides access to weight map values. example:: scene = modo.scene.current() # Get the first selected Mesh mesh = scene.selectedByType("mesh")[0] # Get the weight maps object vmaps = mesh.geometry.vmaps.weight_maps if vmaps: # Get the first weight map found weightMap = vmaps[0] # Set and get values weightMap[0] = 0.333 print weightMap[0] # Iterate and print all weight values if weightMap: for index, weight in enumerate(weightMap): print index, weight

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.WeightMap._accessor

type: property

modo.WeightMap._WeightMap__null(self)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.WeightMap.accessor

type: property

doc: :getter: Returns the internal shared MeshMapAccessor object of the core SDK (lx.object.MeshMap)

modo.WeightMap.clear(self,index)

type: instancemethod

doc: :param int index: If not None, the vertex of this index is deallocated from the map. Otherwise all values of the map are deallocated.

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.WeightMap.fromMesh(cls,geometry,accessor,ID,map_type,name)

type: instancemethod

file: E:\Program Files\Luxology\modo\902\extra\Python\modules\modo\meshgeometry.py

modo.WeightMap.id

type: property

modo.WeightMap.name

type: property

doc: Get or set the name of this mesh map :getter: Returns name as string :setter: Sets name from string